Job Sync API guide

Create and manage job postings on Indeed.

 

legal notice

By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.

API overview

Use the Job Sync API to create and manage job postings on Indeed. Calls are free and do not count toward Sponsored Jobs API usage policy limits.

---

API steps

After you integrate the Job Sync API, you can create and manage job postings with these calls.

---

1. Authenticate

When you become an Indeed partner, Indeed creates an app for your integration. Sign in to Partner Console (opens in a new window) to view the app and your OAuth credentials: client ID, secret, and a 3-legged OAuth authorization code. Exchange those credentials for an access token to authenticate API calls.

---

2. Create job posting

Creates a job posting on Indeed.

To create a job posting with screener questions, see Create job posting with screener questions.

Required fields vary by country to meet local regulations and Indeed policies, so a job created in the United States can behave differently from one created in Japan. The API reference describes country-specific requirements.

Post a separate job posting for each position-location and position-language pair. These postings can share the same url and jobRequisitionId, but each needs a unique jobPostingId so Indeed does not treat them as duplicates.

For jobs in Japan, see Job posting guidelines and examples for Japan.

For this call's limits, see Rate limits.

Request – Create job posting

To create a job posting, call the jobsIngest.createSourcedJobPostings mutation.

In the jobPostings field, provide the job title, description, location, benefits, and job source details, including the source name.

Define these fields in CreateSourcedJobPostingInput:

• body
• metadata
• applyMethod

body field

The required body field uses the SourcedJobPostingBodyInput type and contains the job description. Include working hours, salary, qualifications, holidays, and other job details.

By default, Indeed treats job descriptions as plain text. To use richer formatting, provide the description in HTML.

Indeed normalizes supported HTML and renders it in a standard format for job seekers. HTML that does not follow these guidelines can be rejected or formatted incorrectly:

• Use only supported HTML tags and computed style nodes.

• Escape quotes in HTML:

  <font style=\"font-weight:bold\">Some bold text</font>

• Use literal characters such as < instead of <. HTML entities (opens in a new window) can cause rejection or incorrect formatting.

To use an HTML job description, set these fields in SourcedJobPostingBodyInput:

Job description formatting

Field	Type	Description
description	String!	Required. The job description shown to job seekers. Maximum 65,000 bytes (1 byte for ASCII, 2 to 3 bytes for other characters). It must match SourcedJobPostingMetadataInput.url and use HTML formatting.
descriptionFormatting	SourcedJobPostingFormattingType!	Description format. If the client uses HTML formatting on its job list or job details pages, Indeed policy generally requires HTML for XML and API jobs unless there is a reasonable explanation for not including it. Using HTML helps the job appear as closely as possible to the client version. Poor formatting can lead to complaints from clients and job seekers. To provide the job description in HTML, set this field to RICH_FORMATTING. For more information, see Job description formatting. HTML has restrictions on attributes and element order. Default: TEXT.

metadata field

The required metadata field uses the SourcedJobPostingMetadataInput! type and contains job posting metadata.

metadata field in CreateSourcedJobPostingInput

Field	Type	Description
jobPostingId	String	Required. The job ID in your ATS. These requirements apply: jobPostingId must be unique among jobs managed by your ATS. If multiple requests use the same jobPostingId and sourceName, Indeed treats them as the same job posting. You can use any format, such as digits, letters, a UUID, or an internal ATS identifier. jobPostingId uses UTF-8 encoding and cannot contain 4-byte characters, including emoji. If it does, the request is not processed correctly.
sourceName	String	Required. The SourcedJobPostingJobSourceInput.sourceName field names a group of jobs, such as a parent organization, that someone manages and hires for together. Choose a unique sourceName for each client grouping. If an employer has multiple job groups that different people manage, assign a unique sourceName to each group. For example, if subsidiaries or franchises run multiple branded locations under one company, give those jobs the same sourceName. Each sourceName must be unique across job groups and can have only one sourceType, which identifies the organization type. You cannot change a job’s sourceName. If you change it, Indeed creates a new job posting with a new sourcedPostingId. If the original posting has not expired, this can create an unwanted duplicate.
contactEmail	EmailAddress!	Required. The contact email address in RFC 822 (opens in a new window) format.
contactPhone	PhoneNumber	Required. The client contact phone number in E.164 format (opens in a new window). If the phone number is not in E.164 format, the API returns a validation error.
trackingUrl	WebUrl	This feature is not available in Japan. Optional. This URL tracks job views in external analytics when someone views a job.

applyMethod field

The applyMethod field uses the SourcedJobPostingApplyMethodInput type and defines how job seekers apply. It is required only when the posting uses Indeed Apply screener questions. For those fields, see Screener questions fields.

Hiring manager notes

• jobRequisitionId is optional in the schema, but Indeed requires it when it differs from jobPostingId.

  For Japanese job postings: Set it to the same value as the ID or jobPostingId.

• Hiring manager and recruiter values in SourcedJobPostingJobContactInput are optional in the schema, but Indeed requires them when available.

See also:

• jobRequisitionId and jobPostingId in SourcedJobPostingMetadataInput
• SourcedJobPostingJobContactInput

The API strips any leading or trailing spaces from the SourcedJobPostingJobSourceInput.sourceName and SourcedJobPostingMetadataInput.jobPostingId fields.

For other request fields, see createSourcedJobPostings.

Creates a job posting:

mutation {
  jobsIngest {
    createSourcedJobPostings(input: {
      jobPostings: [{
        body: {
          title: "title 1"
          description: "description 1"
          location: {
            country: "US"
            cityRegionPostal: "Syracuse, New York 13209"
          }
          benefits: []
        }
        metadata: {
          jobSource: {
            companyName: "Company"
            sourceName: "Source"
            sourceType: "Employer"
          }
          jobPostingId: "JobId1"
          datePublished: "2023-01-02T12:00Z"
          url: "http://example.com/careers/job1.html"
          contacts: [{
            contactType: ["contact", "recruiter"]
            contactInfo: {
              contactEmail: "contact@career.example.com"
              contactPhone: "+10001112223"
              contactName: "SL1"
            }
          }],
          trackingUrl: "https://www.example.com/"
        }
      }]
    }) {
      results {
        jobPosting {
          sourcedPostingId
        }
      }
    }
  }
}

mutation CreateJobPostingExample {
  jobsIngest {
    createSourcedJobPostings(input: {
      jobPostings: [{
        body: {
          title: "Customer Support"
          description: "<h2 data-segment-type=\"header\" data-segment-label=\"WorkHours\">Working hours\n</h2><div data-segment-type=\"content\" data-segment-label=\"WorkHours\">8 working hours per day\n  5 working days per week</div>"
          descriptionFormatting: RICH_FORMATTING
          benefits: []
          salary: {
            currency: "JPY"
            period: "HOUR"
            minimumMinor: 2000
            fineGrainedSalaryInformation: {
              totalSalaryMinor: 2000
              workingHours: 1
              fixedOvertimePay: false
            }
          }
          hasProbationaryPeriod: NO
          location: {
            country: "JP"
            streetAddress: "108-0023 東京都港区芝浦3-1-21 田町ステーションタワーS18階"
          }
        }
        metadata: {
          jobSource: {
            companyName: "Sample Company"
            sourceName: "Sample Company"
            sourceType: "Employer"
            employerIds: [{
              type: "YOUR EMPLOYER TYPE PROVIDED BY INDEED"
              id: "EmployerId1"
            }]
          }
          taxonomyClassification: {
            jobTypes: ["75GKK"]
            occupations: ["N3YNG"]
            attributes: ["7ADHN"]
          }
          jobPostingId: "YourJobId1"
          datePublished: "2023-01-01T12:34:56+09:00"
          url: "https://example.com/jobs/aaabbbccc"
          contacts: {
            contactType: "contact",
            contactInfo: {
              contactEmail: "contact@career.example.com"
            }
          },
          trackingUrl: "https://www.example.com/"
        }
        applyMethod: {
          indeedApply: {
            postUrl: "https://example.com/applypost"
            apiToken: "API TOKEN HERE"
          }
        }
      }]
    }) {
      results {
        jobPosting {
          sourcedPostingId
        }
      }
    }
  }
}

Response – Create job posting

Indeed generates a unique sourcedPostingId for each job posting.

{
  "data": {
    "jobsIngest": {
      "createSourcedJobPostings": {
        "results": [
          {
            "jobPosting": {
              "sourcedPostingId": "e29aaba8-2cef-447f-a1e0-bcb7ec3fa730",
              "employerJobId": "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iL2UyOWFhYmE4LTJjZWYtNDQ3Zi1hMWUwLWJjYjdlYzNmYTczMA=="
            }
          }
        ]
      }
    }
  }
}

The sourcedPostingId value depends on whether the API accepts or rejects the posting:

• If the API accepts a complete job posting, sourcedPostingId contains the Indeed employer job ID. Use this value to expire or update the job. After spam and fraud checks, Indeed indexes the job and makes it available on Indeed within minutes to hours.

  If you create a job through either the createSourcedJobPostings mutation or an XML job feed, expiration of the job requires an action on your part. You must explicitly expire that job.

  Even if someone calls the updateSourcedJobPostings mutation or clicks Edit on the Indeed job details page for this job, you must explicitly expire that job.

  See also:

  • createSourcedJobPostings
  • updateSourcedJobPostings
  • Job details page (signed in to Indeed)
  • Job Sync XML feed guide

• If the API rejects the job posting because of missing or malformed data, sourcedPostingId is null, and the API returns an error in the standard GraphQL errors (opens in a new window) array.

To troubleshoot validation errors, see Troubleshoot GraphQL errors and Validation (opens in a new window) in the GraphQL documentation.

Use sourcedPostingId to expire a job posting.

---

3. Create job posting with screener questions

Screener questions help employers identify applicants who meet their criteria, so they spend more time with qualified candidates. Indeed does not host screener questions for you. If your system supports them, you must implement them for Indeed to approve your integration.

Request – Create job posting with screener questions

To create a job posting with Indeed Apply screener questions, call jobsIngest.createSourcedJobPostings. In the jobPostings field, provide the job title, description, location, benefits, and job source details, including the source name.

Required fields vary by country to meet local regulations and Indeed policies. For those fields and country-specific requirements, see the createSourcedJobPostings mutation fields.

To show screener questions in the Indeed Apply flow, you must also set the applyMethod field in CreateSourcedJobPostingInput. It uses the SourcedJobPostingApplyMethodInput type, defines how job seekers apply, and is required for postings with screener questions.

Use one of these methods:

Method 1

Format questions in JSON, then host the file at an HTTPS URL.

For each job, set that URL in SourcedJobPostingIndeedApplyInput.applyQuestions.

See Indeed Apply integration guide for ATS partners > Add Indeed Apply screener questions.

Method 2

Define the screener question schema in SourcedJobPostingIndeedApplyInput.applyQuestionsDetails.

See Indeed Apply integration guide for ATS partners > Considerations.

These fields define screener questions:

Screener questions fields

Field	Type	Description
applyQuestions	URI	Required when you create a job posting with screener questions by using method 1. A URL that returns a JSON-formatted string of questions for the Indeed Apply flow.
applyQuestionsDetails	IndeedApplyQuestionsDetailsInput	Required when you create a job posting with screener questions by using method 2. The screener question schema for the Indeed Apply flow.
questions	IndeedApplyScreenerQuestionsDefinitionInput	The screener questionnaire definition for the Indeed Apply flow, aligned with the V1.x standard.
screenerQuestions	[ScreenerQuestionBodyInput!]!	General questions about the job, such as work experience, skills, or certifications. Do not include demographic questions about ethnicity, gender, or disability here. Put those in demographicQuestions instead.
demographicQuestions	[DemographicQuestionsBodyInput!]!	Questions about a job applicant’s protected class, such as ethnicity, gender, or disability. Some jurisdictions regulate these questions. Indeed systems, and possibly your systems, must handle them differently. Demographic questions are limited to U.S.-based jobs for EEO compliance. Do not include general screener questions here. Put those in screenerQuestions instead.

Method 1 example: Create Indeed Apply screener questions using applyQuestions:

mutation CreateSourcedJobPostings($companyName: String!$sourceName: String!$indeedApplyToken: ID!) {
  jobsIngest {
    createSourcedJobPostings(input: {
      jobPostings: [{
        body: {
          title: "Software Engineer - All SQ and SQ types"
          description: "We are looking for a talented software engineer"
          descriptionFormatting: TEXT
          location: {
            latitude: 43.0729
            longitude: -76.2161
            country: "US"
            streetAddress: "123 Main St"
            cityRegionPostal: "Syracuse, New York 13209"
          }
          benefits: ["Health Insurance", "401k"]
        }
        metadata: {
          jobSource: {
            companyName: $companyName
            sourceName: $sourceName
            sourceType: "Employer"
          }
          jobPostingId: "JOB-12345"
          datePublished: "2023-01-01T12:00:00Z"
          url: "https://example.com/jobs/12345"
          contacts: [{
            contactType: ["contact"]
            contactInfo: {
              contactEmail: "jobs@example.com"
              contactName: "HR Department"
            }
          }],
          visibility: {
            hideFromIndeedSearch: {
              reason: "OPT_OUT"
            }
          }
          trackingUrl: "https://www.example.com/"
        }
        applyMethod: {
          indeedApply: {
            postUrl: "https://example.com/apply"
            apiToken: $indeedApplyToken,
            resumeRequired: NO,
            applyQuestions: "https://your-webserver.com/job/questions/jb12345"
          }
        }
      }]
    }) {
      results {
        jobPosting {
          sourcedPostingId
          employerJobId
        }
      }
    }
  }
}

Method 2 example: Create Indeed Apply screener questions using applyQuestionsDetails:

mutation CreateSourcedJobPostings($companyName: String!$sourceName: String!$indeedApplyToken: ID!) {
  jobsIngest {
    createSourcedJobPostings(input: {
      jobPostings: [{
        body: {
          title: "Software Engineer - All SQ and SQ types"
          description: "We are looking for a talented software engineer"
          descriptionFormatting: TEXT
          location: {
            latitude: 43.0729
            longitude: -76.2161
            country: "US"
            streetAddress: "123 Main St"
            cityRegionPostal: "Syracuse, New York 13209"
          }
          benefits: ["Health Insurance", "401k"]
        }
        metadata: {
          jobSource: {
            companyName: $companyName
            sourceName: $sourceName
            sourceType: "Employer"
          }
          jobPostingId: "JOB-12345"
          datePublished: "2023-01-01T12:00:00Z"
          url: "https://example.com/jobs/12345"
          contacts: [{
            contactType: ["contact"]
            contactInfo: {
              contactEmail: "jobs@example.com"
              contactName: "HR Department"
            }
          }],
          visibility: {
            hideFromIndeedSearch: {
              reason: "OPT_OUT"
            }
          }
          trackingUrl: "https://www.example.com/"
        }
        applyMethod: {
          indeedApply: {
            postUrl: "https://example.com/apply"
            apiToken: $indeedApplyToken,
            resumeRequired: NO,
            applyQuestionsDetails: {
              questions: {
                screenerQuestions: [{
                  text: {
                    integer: {
                      questionInput: {
                        id: "int1"
                        question: "How many years of experience do you have?"
                        minValue: 0
                        maxValue: 5
                        required: true,
                      }
                    }
                  }
                } {
                  text: {
                    decimal: {
                      questionInput: {
                        id: "dec1"
                        question: "What is your current hourly rate?"
                        minValue: 10.0
                        maxValue: 120.0
                        required: false
                      }
                      qualification: {
                        type: NON_BLOCKING
                        range: {
                          minValue: 15.0,
                          maxValue: 100.0
                        }
                      }
                    }
                  }
                } {
                  text: {
                    freeform: {
                      id: "free1"
                      question: "Briefly describe your relevant experience"
                      maxCharCount: 500
                      required: true
                    }
                  }
                } {
                  textarea: {
                    id: "ta1"
                    question: "Tell us about your most challenging project"
                    maxCharCount: 2000
                    required: true
                  }
                } {
                  select: {
                    questionInput: {
                      id: "sel1"
                      question: "What programming language are you most proficient in?"
                      options: [{
                        value: "java",
                        label: "Java"
                      } {
                        value: "python",
                        label: "Python"
                      } {
                        value: "javascript",
                        label: "JavaScript"
                      } {
                        value: "csharp",
                        label: "C#"
                      }]
                      required: true
                    }
                    qualification: {
                      type: NON_BLOCKING
                      match: {
                        values: ["java", "python"]
                      }
                    }
                  }
                } {
                  multiselect: {
                    questionInput: {
                      id: "multi1"
                      question: "Which of the following technologies have you worked with?"
                      options: [{
                        value: "react",
                        label: "React"
                      } {
                        value: "angular",
                        label: "Angular"
                      } {
                        value: "vue",
                        label: "Vue"
                      } {
                        value: "svelte",
                        label: "Svelte"
                      }]
                      required: true
                    }
                    qualification: {
                      type: NON_BLOCKING
                      match: {
                        type: ANY,
                        values: ["react", "angular"]
                      }
                    }
                  }
                } {
                  date: {
                    questionInput: {
                      id: "date1"
                      question: "When can you start?"
                      format: "MM-dd-yyyy"
                      minDate: "2025-02-01T00:00:00Z"
                      maxDate: "2025-12-31T00:00:00Z"
                      required: true
                    }
                    qualification: {
                      type: NON_BLOCKING
                      range: {
                        minValue: "2025-02-15T00:00:00Z"
                        maxValue: "2025-12-31T00:00:00Z"
                      }
                    }
                  }
                } {
                  file: {
                    id: "file1"
                    question: "Please upload a sample of your work"
                    format: ["pdf", "doc", "docx"]
                    required: true,
                    min: 1
                  }
                } {
                  information: {
                    id: "info1"
                    text: "<p>Please note that all candidates must complete a coding assessment as part of the interview process.</p>"
                  }
                } {
                  pageBreak: {
                    id: "page1"
                  }
                } {
                  hierarchical: {
                    id: "hier1"
                    question: "Select your location"
                    options: [{
                      value: "us",
                      label: "United States"
                    } {
                      value: "ca",
                      label: "Canada"
                    } {
                      value: "uk",
                      label: "United Kingdom"
                    }]
                    hierarchicalOptions: [{
                      id: "states"
                      condition: {
                        id: "hier1",
                        values: ["us"]
                      }
                      options: [{
                        value: "ny",
                        label: "New York"
                      }, {
                        value: "ca",
                        label: "California"
                      }]
                    } {
                      id: "provinces"
                      condition: {
                        id: "hier1",
                        values: ["ca"]
                      }
                      options: [{
                        value: "on",
                        label: "Ontario"
                      }, {
                        value: "bc",
                        label: "British Columbia"
                      }]
                    }]
                    required: true
                  }
                }]
                demographicQuestions: [{
                  textarea: {
                    id: "demo_ta1"
                    question: "Please describe any accommodations you may need"
                    maxCharCount: 1000
                    required: false
                  }
                } {
                  text: {
                    freeform: {
                      id: "demo_free1"
                      question: "How did you hear about this position?"
                      maxCharCount: 200
                      required: false
                    }
                  }
                } {
                  text: {
                    integer: {
                      id: "demo_int1"
                      question: "How many dependents do you have?"
                      minValue: 0
                      maxValue: 20
                      required: false
                    }
                  }
                } {
                  text: {
                    decimal: {
                      id: "demo_dec1"
                      question: "What is your desired salary?"
                      minValue: 30000.0
                      maxValue: 200000.0
                      required: false
                    }
                  }
                } {
                  text: {
                    numeric: {
                      id: "demo_num1"
                      question: "What is your zip code?"
                      required: false
                    }
                  }
                } {
                  select: {
                    id: "demo_sel1"
                    question: "What is your gender?"
                    options: [{
                      value: "male",
                      label: "Male"
                    } {
                      value: "female",
                      label: "Female"
                    } {
                      value: "non-binary",
                      label: "Non-binary"
                    } {
                      value: "prefer-not",
                      label: "Prefer not to say"
                    }]
                    required: false
                  }
                } {
                  multiselect: {
                    id: "demo_multi1"
                    question: "Which of the following describe your ethnicity? (Select all that apply)"
                    options: [{
                      value: "hispanic",
                      label: "Hispanic or Latino"
                    } {
                      value: "white",
                      label: "White"
                    } {
                      value: "black",
                      label: "Black or African American"
                    } {
                      value: "asian",
                      label: "Asian"
                    } {
                      value: "native"
                      label: "Native American or Alaska Native"
                    } {
                      value: "pacific"
                      label: "Native Hawaiian or Pacific Islander"
                    } {
                      value: "prefer-not",
                      label: "Prefer not to say"
                    }]
                    required: false
                  }
                } {
                  date: {
                    id: "demo_date1"
                    question: "What is your date of birth?"
                    format: "MM/dd/yyyy"
                    required: false
                  }
                } {
                  information: {
                    id: "demo_info1"
                    text: "<p>The following questions are for Equal Employment Opportunity purposes only and do not affect your application status.</p>"
                  }
                } {
                  pageBreak: {
                    id: "demo_page1"
                  }
                }]
              }
            }
          }
        }
      }]
    }) {
      results {
        jobPosting {
          sourcedPostingId
          employerJobId
        }
      }
    }
  }
}

Response – Create job posting with screener questions

For an example response, see Response - Create job posting.

---

4. Get job posting status by ID

Get the status of a job posting by ID.

Authentication for get job posting status by ID

Use one of these token types:

Authentication for get job posting status by ID

Token type	Description
3-legged access token (ATS integrations)	If the user is signed out or the token is expired, show a Log in with Indeed button instead of job status. After sign-in, get a 3-legged token. Register an endpoint to receive the authorization code.
2-legged access token with advertiser specified (direct employer/agency integrations)	Only direct employer and agency integrations can use this token type because the advertiser and integration owner are the same entity. Agencies already using 2-legged OAuth for Sponsored Jobs API already have this token type.

Both token types require the employer_access and employer.hosted_job scopes. For 3-legged tokens, also request offline_access to reduce repeated sign-ins for status checks. For scope details, see Scopes.

A 3-legged token is tied to the user who authorized it. If that user is not linked to the requested advertiser or employer account, the request returns FORBIDDEN. Keep tokens secure, and never reuse one user’s token for another user’s job, which can expose that job to the wrong user.

2-legged tokens cannot be refreshed, so request a new one when it expires. 3-legged tokens can be refreshed only if you requested offline_access during initial authorization. Refresh them before expiration to avoid repeated sign-ins.

After you get a token, include it in the query.

Request – Get job posting status by ID

To get the status of a job posting by ID, call the node query with an OAuth token.

node takes id, which is the employer job ID in Base64-encoded IRI format. Use the employerJobId returned by createSourcedJobPostings.

query {
  node(id:
    "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMQ=="
    ) {
    ...on EmployerJob {
      id
      jobData {
        title
        datePostedOnIndeed
        dateCreated
        description
        company
        jobLocation {
          countryCode
          city
          postalCode
          fullAddress
        }
        externalJobPageUrl
        externalPostingMetadata {
          jobPostingId
          jobRequisitionId
          campaignCategories
          trackingUrls
          isIntegratedJob
        }
      }
      managementUrls {
        viewJob
      }
      seatsConnection {
        pageInfo {
          endCursor
          hasNextPage
          hasPreviousPage
          startCursor
        }
        seats {
          jobPost {
            id
            externalPartnerCallToAction(input: {
              locale: "en-us"
            }) {
              imageAltText
              imageUrl
            }
            status {
              globalStatus {
                lifecycleStatus
                isIndeedApplyActive
              }
              surfaceStatuses {
                isRejected
                isSponsorshipRequired
                isMissingRequiredSponsorship
              }
            }
          }
        }
      }
    }
  }
}

Response – Get job posting status by ID

node returns the EmployerJob object, which implements the Node interface, for the specified employer job ID.

This query returns one result, so the cursors are identical and there are no next or previous pages.

{
  "data": {
    "node": {
      "id": "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMQ==",
      "jobData": {
        "title": "Certified Nursing Assistant CNA",
        "datePostedOnIndeed": "2022-03-22T20:33:28Z",
        "dateCreated": "2022-03-22T20:33:28Z",
        "description": "Anytown Health and Rehabilitation Center in Anytown, USA is a 186-bed center offering a variety of individualized, health care services for our patients and residents. We are seeking a qualified and committed team member to join our team.",
        "company": "Anytown Health and Rehabilitation Center",
        "jobLocation": {
          "countryCode": "US",
          "city": "Cambridge",
          "postalCode": null,
          "fullAddress": null
        },
        "externalJobPageUrl": "http://www.indeed.com/job/certified-nursing-assistant-cna-9354ed892ad3a1b6",
        "externalPostingMetadata": {
          "jobPostingId": "CBA-Anytown-Posting-Id",
          "jobRequisitionId": "CBA-Anytown-Req-Id",
          "campaignCategories": [],
          "trackingUrls": [],
          "isIntegratedJob": false
        }
      },
      "managementUrls": {
        "viewJob": "https://employers.indeed.com/jobs/view?employerJobId=aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMQ=="
      },
      "seatsConnection": {
        "pageInfo": {
          "endCursor": "YVhKcE9pOHZZWEJwY3k1cGJtUmxaV1F1WTI5dEwwcHZZbEJ2YzNRdk5EQXhOVFkxTW1OaFpEYzJZVFF4TlE9PQ==",
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "YVhKcE9pOHZZWEJwY3k1cGJtUmxaV1F1WTI5dEwwcHZZbEJ2YzNRdk5EQXhOVFkxTW1OaFpEYzJZVFF4TlE9PQ=="
        },
        "seats": [
          {
            "jobPost": {
              "id": "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0pvYlBvc3QvNDAxNTY1MmNhZDc2YTQxNQ==",
              "externalPartnerCallToAction": [
                {
                  "imageUrl": "https://dlogqfjusi9uq.cloudfront.net/cta/en_US/not_searchable.svg",
                  "imageAltText": "Update needed on Indeed"
                }
              ],
              "status": {
                "globalStatus": [
                  {
                    "lifecycleStatus": "INACTIVE",
                    "isIndeedApplyActive": false
                  }
                ],
                "surfaceStatuses": [
                  {
                    "isRejected": false,
                    "isSponsorshipRequired": false,
                    "isMissingRequiredSponsorship": false
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

EmployerJob contains these fields:

Response – Get job posting status by ID

Field	Description
id Type: ID!	Employer Job ID (EJID), which is an encoded version of sourcedPostingId in Indeed Resource Identifier (IRI) format. Use this value to expire a job posting, update a job posting, or upsert a job posting.
jobData Type: EmployerJobData	Contains job posting data. EmployerJobExternalPostingMetadata includes isIntegratedJob. This Boolean shows how the job was posted: If true, the job was posted through an XML or API integration. If false, the job was posted through web crawling or directly on Indeed.
managementUrls.viewJob Type: WebUrl!	URL for the employer’s job detail page on Indeed. On this page, users can review job posting details, including moderation information, and see how the job appears to candidates.
seatsConnection Type: EmployerJobSeatsConnection	Paginated list of job seats. A job seat contains location, schedule, and compensation details. A job can have zero or more seats, and each seat maps to a job posting.
globalStatus.lifecycleStatus Type: JobPostLifecycleStatus	PENDING – The job is still processing. ACTIVE – The job is processed and unexpired. INACTIVE – The job is inactive or expired.
globalStatus.isIndeedApplyActive Type: Boolean!	Shows whether Indeed Apply is enabled for the job.

Job status

Show the Indeed job status as a link to Indeed’s job management page, where users can view more details.

1. Call the externalPartnerCallToAction subquery under seats.jobPost to get the call-to-action image. Specify a supported locale.

   locale falls back to the base language when the exact locale is not supported. For example, fr_CH falls back to fr. If no match exists, the default is en_US.

   The query returns an imageUrl for one of these job status images:

   Job status

   Image	Description
   	The job is live on Indeed. The job appears in search results.
   	The job is expired on Indeed. The job does not appear in search results.
   	The job needs sponsorship on Indeed. The job does not appear in search results.
   	The job status is unknown on Indeed. Either the job is not found on Indeed, or the user account does not have access to the job. Note: The API does not return the not_found.svg image. Call-to-action images are part of the job data, so the API cannot return this image if the job is not found. However, the ATS can use this image if needed.
   	The job needs an update on Indeed before it can appear in search results.

2. Query managementUrls.viewJob to get the URL for the user’s job detail page.

3. Embed the call-to-action image as a clickable link on the job detail page.

4. Update the job posting status when the user opens the page.

See Frequently asked questions > Job visibility.

The following examples show the job status in an ATS.

Job details page (signed in to Indeed)

Searchable status on job details page

Job list page (signed in to Indeed)

Job list page signed in to Indeed

---

5. List job postings by IDs

View details for multiple job postings. For authentication, see Authentication for get job posting status by ID.

Request – List job postings by IDs

nodes takes ids, an array of employer job IDs in Base64-encoded IRI format. Use the employerJobId values returned by createSourcedJobPostings.

query {
  nodes(ids: [
    "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMQ=="
  ]) {
    ...on EmployerJob {
      id
      jobData {
        title
        datePostedOnIndeed
        dateCreated
        description
        company
        jobLocation {
          countryCode
          city
          postalCode
          fullAddress
        }
        externalJobPageUrl
        externalPostingMetadata {
          jobPostingId
          jobRequisitionId
          campaignCategories
          trackingUrls
          isIntegratedJob
        }
      }
      managementUrls {
        viewJob
      }
      seatsConnection {
        pageInfo {
          endCursor
          hasNextPage
          hasPreviousPage
          startCursor
        }
        seats {
          jobPost {
            id
            externalPartnerCallToAction(input: {
              locale: "en-us"
            }) {
              imageAltText
              imageUrl
            }
            status {
              globalStatus {
                lifecycleStatus
                isIndeedApplyActive
              }
              surfaceStatuses {
                isRejected
                isSponsorshipRequired
                isMissingRequiredSponsorship
              }
            }
          }
        }
      }
    }
  }
}

Response – List job postings by IDs

Returns an array of EmployerJob objects. For the field descriptions, see the response fields table.

{
  "data": {
    "nodes": [{
      "id": "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMQ==",
      "jobData": {
        "title": "Certified Nursing Assistant CNA",
        "datePostedOnIndeed": "2022-03-22T20:33:28Z",
        "dateCreated": "2022-03-22T20:33:28Z",
        "description": "Anytown Health and Rehabilitation Center in Anytown, USA is a 186-bed center offering a variety of individualized, health care services for our patients and residents. We are seeking a qualified and committed team member to join our team.",
        "company": "Anytown Health and Rehabilitation Center",
        "jobLocation": {
          "countryCode": "US",
          "city": "Cambridge",
          "postalCode": null,
          "fullAddress": null
        },
        "externalJobPageUrl": "http://www.indeed.com/job/certified-nursing-assistant-cna-9354ed892ad3a1b6",
        "externalPostingMetadata": {
          "jobPostingId": "CBA-Anytown-Posting-Id",
          "jobRequisitionId": "CBA-Anytown-Req-Id",
          "campaignCategories": [],
          "trackingUrls": [],
          "isIntegratedJob": false
        }
      },
      "managementUrls": {
        "viewJob": "https://employers.indeed.com/jobs/view?employerJobId=aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMQ=="
      },
      "seatsConnection": {
        "pageInfo": {
          "endCursor": "YVhKcE9pOHZZWEJwY3k1cGJtUmxaV1F1WTI5dEwwcHZZbEJ2YzNRdk5EQXhOVFkxTW1OaFpEYzJZVFF4TlE9PQ==",
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "YVhKcE9pOHZZWEJwY3k1cGJtUmxaV1F1WTI5dEwwcHZZbEJ2YzNRdk5EQXhOVFkxTW1OaFpEYzJZVFF4TlE9PQ=="
        },
        "seats": [{
          "jobPost": {
            "id": "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0pvYlBvc3QvNDAxNTY1MmNhZDc2YTQxNQ==",
            "externalPartnerCallToAction": [{
              "imageUrl": "https://dlogqfjusi9uq.cloudfront.net/cta/en_US/not_searchable.svg",
              "imageAltText": "Update needed on Indeed"
            }],
            "status": {
              "globalStatus": [{
                "lifecycleStatus": "INACTIVE",
                "isIndeedApplyActive": false
              }],
              "surfaceStatuses": [{
                "isRejected": false,
                "isSponsorshipRequired": false,
                "isMissingRequiredSponsorship": false
              }]
            }
          }
        }]
      }
    }, {
      "id": "aXJpOi8vYXBpcy5pbmRlZWQuY29tL0VtcGxveWVySm9iLzkxZGU0ZjVhLWE1MWYtNGQ1Ni1iOWI0LWNhMDQzZWVjNDAzMZ==",
      ...
    }]
  }
}

To show the Indeed job status in your ATS, see Job status.

---

6. Upsert job posting

Upserting versus updating job postings on Indeed

• If you submitted the job posting to Indeed, upsert it.
• If another partner submitted it, update the posting. Updates are primarily for ad agencies.

Japan only: All partners except ad agencies and Indeed PLUS Publisher Network partners can update the posting.

See also:

• Upsert the posting
• Update the posting

Upsert a job posting on Indeed and the Indeed PLUS publishing network. An upsert updates a job posting if it exists, or creates it if it does not. Provide all required job fields, even if those values are not changing.

For this call’s limits, see Rate limits.

Request – Upsert job posting

To upsert a job posting, call jobsIngest.createSourcedJobPostings, just as you do to create a job posting.

Upsert job posting example

This example upserts a U.S.-based job posting, repeating the Create job posting example with a new title and description.

Use the same values for jobPostingId, sourceName, and the OAuth client ID that you used when you created the job posting.

mutation {
  jobsIngest {
    createSourcedJobPostings(input: {
      jobPostings: [{
        body: {
          title: "Updated job title"
          description: "Updated job description"
          location: {
            country: "US"
            cityRegionPostal: "Syracuse, New York 13209"
          }
          benefits: []
        }
        metadata: {
          jobSource: {
            companyName: "Company"
            sourceName: "Source"
            sourceType: "Employer"
          }
          jobPostingId: "JobId1"
          datePublished: "2023-01-02T12:00Z"
          url: "http://example.com/careers/job1.html"
          contacts: [{
            contactType: ["contact", "recruiter"]
            contactInfo: {
              contactEmail: "contact@career.example.com"
              contactPhone: "+10001112223"
              contactName: "SL1"
            }
          }]
        }
      }]
    }) {
      results {
        jobPosting {
          sourcedPostingId
        }
      }
    }
  }
}

Response – Upsert job posting

The mutation returns the same sourcedPostingId that Indeed generated when it created the job posting. This value is the Indeed employer job ID, which you use to expire or update the job.

---

7. Expire job posting

Removes a job posting from Indeed and the Indeed PLUS publishing network.

The Job Sync API doesn't auto-expire postings, so you must call it explicitly to expire any job you remove from your career page.

The ATS controls job posting creation and expiration.

If you create a job through either the createSourcedJobPostings mutation or an XML job feed, expiration of the job requires an action on your part. You must explicitly expire that job.

Even if someone calls the updateSourcedJobPostings mutation or clicks Edit on the Indeed job details page for this job, you must explicitly expire that job.

See also:

• createSourcedJobPostings
• updateSourcedJobPostings
• Job details page (signed in to Indeed)
• Job Sync XML feed guide

To reactivate an expired job, call jobsIngest.createSourcedJobPostings with the jobPostingId and sourceName values from the expired job, just as you would when updating an active job. To record when the ATS reactivated the job, update datePublished.

You can reactivate a job for 30 days after it expires. After that, Indeed can archive the job’s statistics and configuration, and reactivation usually returns a new sourcedPostingId, so make sure your code handles both the original value and a new one.

Always save the sourcedPostingId value. You need it to expire a job.

Request – Expire job posting

To expire a job posting, call jobsIngest.expireSourcedJobsBySourcedPostingId with sourcedPostingId. Set it to the Indeed employer job ID from the job posting.

Expire job posting example

This example expires jobs for a single-feed client:

mutation {
  jobsIngest {
    expireSourcedJobsBySourcedPostingId(input: {
      jobs: [{
        sourcedPostingId: "123"
      }, {
        sourcedPostingId: "456"
      }]
    }) {
      results {
        trackingKey
      }
    }
  }
}

Response – Expire job posting

Indeed does not verify whether the job exists before it responds. The response is always ACCEPTED.

The response shows the tracking ID:

{
  "data": {
    "jobsIngest": {
      "expireSourcedJobsBySourcedPostingId": {
        "results": [
          {
            "trackingKey": "1h958ob2601bv800"
          }
        ]
      }
    }
  }
}

For each sourcedPostingId that you specify, the API returns an ExpireSourcedJobResult object with these fields:

Response – Expire job posting

Field	Description
trackingKey Type: String!	Tracking ID from Indeed.
inputData Type: ExpireSourcedJobResultInfo	A union that includes the unique job ID.

The API can also return errors for failed expiration attempts, such as invalid requests or backend failures, in the standard GraphQL errors (opens in a new window) array. Log them so you can identify the failure type on Indeed. For more information, see Validation (opens in a new window) in the GraphQL documentation.

---

8. Troubleshoot errors

• For errors specific to the Job Sync API, see Troubleshoot errors.
• For OAuth errors that occur before you reach GraphQL, see Troubleshoot OAuth errors.
• For common reasons jobs do not appear on Indeed, see FAQs.

---

Rate limits

Indeed rate-limits both Job Sync API mutations:

• jobsIngest.createSourcedJobPostings, which creates and upserts job postings
• jobsIngest.expireSourcedJobsBySourcedPostingId, which expires them

Indeed sets the limits above normal daily usage to keep the API available, but throttles large volumes over short periods, so spread requests over 10 minutes.

If you exceed a limit, the API returns a GraphQL error with extensions.code set to SUBREQUEST_HTTP_ERROR and HTTP status 429.

The limits depend on request size:

Job Sync API rate limits

Request size	Rate limit
Small requests that contain 1 job or expiration	150 requests per second 4,000 requests per minute 20,000 requests per 10 minutes 80,000 requests per hour
Medium requests that contain 2 to 10 jobs or expirations	30 requests per second 800 requests per minute 4,000 requests per 10 minutes 16,000 requests per hour
Large requests that contain more than 10 jobs or expirations	1 request per second 40 requests per minute 200 requests per 10 minutes 800 requests per hour

See also:

• RFC 6585: Additional HTTP Status Codes - 429 Too Many Requests (opens in a new window)
• Rate limiting (Indeed PLUS)

---

GraphQL API references

• jobsIngest.createSourcedJobPostings — Creates, upserts, or reactivates job postings on Indeed.
• node — Gets job posting status by ID.
• nodes — Lists job postings by IDs.
• jobsIngest.expireSourcedJobsBySourcedPostingId — Expires a job posting.

 

Was this page helpful?