Job Sync XML feed guide
Use an XML feed to define your jobs and how they appear on Indeed.
- By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
Overview
#Before you start, review Indeed + Your ATS (opens in a new window).
The Indeed XML feed lists your jobs and controls how they appear on Indeed. You can also add Indeed Apply to jobs.
When your clients create jobs in your system, the feed sends them to Indeed.
The XML feed
#Create and maintain an XML file that lists your jobs. Indeed checks the file for changes in one of these ways:
- By crawling an XML URL
- By crawling an FTP or SFTP site that your client hosts
- By receiving the file on an Indeed FTP server (compressed files are recommended)
Include every job from your career page. Indeed doesn't accept partial feeds or let you opt in only some jobs. If the feed is missing jobs, Indeed might reject it or reduce job visibility.
Include all job details that job seekers can see on your website. For example, if your job listings show salary, include the <salary> element. If they don't, you can omit salary.
Basic feed nodes
#Basic feed nodes set general details for the feed, such as the XML version, encoding, and, for ATS developers, ATS information.
If Indeed asks you to change your feed, make the changes. Otherwise, Indeed might not load the feed, or might stop loading a feed that's already active.
| Element | Description |
|---|---|
Required The XML declaration. Example: | |
Required The root node of the feed. | |
ATS developers only The name of the ATS that published the job. Example: | |
ATS developers only The URL of the ATS that published the job. Example: | |
Required One job. Add one |
Job feed elements
#Job feed elements describe each job.
| Element | Description |
|---|---|
<title> | Required (except in Japan) The job title. Don't include salary, employment type, location, descriptions, or headlines. See also Misleading Content and Activities (opens in a new window). Example: |
<date> | Required The date you first published the job, in ISO 8601 format (opens in a new window). If your site shows the publish date, it must match this date. Example: |
<referencenumber> | Required A unique ID for this job posting. Give each location of a job its own value. Don't change the value after you set it. Example: |
<requisitionid> | Required The job's requisition ID, formerly called external job ID. Your system probably uses it to track the role and its applicants. It might appear on your career page. Use the same value for every posting of the job, across feeds and locations. The value doesn't have to be unique. Example: |
<apijobid> | The job ID. Include it only if it differs from Indeed integrations such as Candidate Sync use it to send candidate information to your system. Example: |
<url> | Required The URL of the job on your site. Use the job description page, not the application page. To track clicks from Indeed, include Example: |
<company> | Required The company or brand name that job seekers know. It appears on the job post on Indeed. For subsidiaries or franchises, use the brand or location name, not the parent organization. Example: |
<sourcename> | ATS developers only Required The parent organization that is hiring. For subsidiaries or franchises with several locations, use the same value for all jobs. Example: |
<city> | Required The job's city. Example: |
<state> | Required The job's state, as a postal abbreviation. Outside the US, use the province or region. Example: |
<country> | Required The job's country. Example: |
<postalcode> | Required if on the career site The job's postal code. Example: |
<streetaddress> | Required if on the career site The street address of the main work location, including the street name and number. Indeed uses it for location-based search and display. Example: |
<email> | Required The email address of the client's Indeed account. Indeed uses it to verify the business that posts the job. Example: |
<description> | Required The job description that job seekers see on Indeed. Match the content and order of your Indeed might remove buttons or link text that doesn't make sense on Indeed. Use HTML formatting. For supported tags, see Formatting guidelines. Example: |
<salary> | Required if on the career site The job's salary. For best practices, see How to Display Pay Information in Job Postings (opens in a new window). If a job has no salary, leave this element empty. Indeed might also take salary from the job description, as well as or instead of this element. If the salary isn't in a valid number format, Indeed might not show it. For the most predictable results, follow the best practices and set this element. Examples: |
<education> | Required if on the career site The education level the job requires. Example: |
<jobtype> | Required if on the career site The job type: full-time or part-time. Indeed might also take this value from other job content. Example: |
<category> | A comma-separated list of job categories that help job seekers narrow their search. Indeed strongly recommends this element. It helps you manage jobs, lets clients sponsor jobs by category, and shows more details from the job page, such as the facility or department. Example: |
<experience> | Required if on the career site The experience the job requires. Example: |
<expirationdate> | Required if on the career site The date hiring for the role ends. After this date, Indeed might remove the job from search results. By default, Indeed reads the date in the CST time zone. Example: |
<tracking_url> | Note: This feature is not available in Japan. A unique URL that tracks clicks on the job. Each time a user clicks the job, Indeed sends a Example: |
<remotetype> | The type of remote work. Use one of these values:
Indeed doesn't use this element to set the job location. For more about remote jobs, see How to post a remote job on Indeed (opens in a new window) (Japanese (opens in a new window)). For text to include in remote job postings, see the XML feed FAQ. Example: |
<lastactivitydate> | The time of your system's most recent action on this job, such as a candidate review or job update. Example: |
<billingId> | An ID that clients use internally for their business units. Example: |
<hide_from_indeed_search> | Note: This feature is not available in Japan. Hides the job from Indeed search. Use one of these reason codes:
Example: |
XML feed example
#This XML feed defines one job:
<?xml version="1.0" encoding="utf-8"?><source> <!--publisher is applicable to ATS developers only--> <publisher>ATS Name</publisher> <!--publisherurl is applicable to ATS developers only--> <publisherurl>http://www.atssite.com</publisherurl> <job> <title> <![CDATA[Sales Executive]]> </title> <date> <![CDATA[2021-06-29T22:49:39Z]]> </date> <referencenumber> <![CDATA[unique123131]]> </referencenumber> <requisitionid> <![CDATA[ab1212]]> </requisitionid> <url> <![CDATA[http://www.examplesite.com/viewjob.cfm?jobid=unique123131&source=Indeed]]> </url> <company> <![CDATA[ABC Hospital]]> </company> <sourcename> <![CDATA[ABC Medical Group]]> </sourcename> <city> <![CDATA[Phoenix]]> </city> <state> <![CDATA[AZ]]> </state> <country> <![CDATA[US]]> </country> <postalcode> <![CDATA[85003]]> </postalcode> <streetaddress> <![CDATA[123 fake street Phoenix AZ, 85003]]> </streetaddress> <email> <![CDATA[example@abccorp.com]]> </email> <description> <![CDATA[Do you have 1-3 years of sales experience? Are you relentless at closing the deal? Are you ready for an exciting and high-speed career in sales? If so, we want to hear from you! [...] We provide competitive compensation, including stock options and a full benefit plan. As a fast-growing business, we offer excellent opportunities for exciting and challenging work. As our company continues to grow, you can expect unlimited career advancement! ]]> </description> <salary> <![CDATA[$50000 per year]]> </salary> <education> <![CDATA[Bachelors]]> </education> <jobtype> <![CDATA[fulltime, parttime]]> </jobtype> <category> <![CDATA[Category1, Category2, CategoryN]]> </category> <experience> <![CDATA[5+ years]]> </experience> <expirationdate> <![CDATA[2021-11-08]]> </expirationdate> <remotetype> <![CDATA[Fully remote]]> </remotetype> <indeed-apply-data>COVERED IN A LATER SECTION</indeed-apply-data> </job></source>Indeed shows the job like this:
Formatting guidelines
#In job descriptions, wrap HTML in CDATA tags. Use the same HTML as your website.
Indeed converts HTML to a standard format for job seekers, so the HTML doesn't need to follow strict standards.
Don't use HTML entities (opens in a new window) in XML feeds. Use literal characters instead, such as < instead of <. Indeed might reject or misformat content that contains HTML entities.
| Tag | Description |
|---|---|
<b> | Bold text. |
| Header. Text in header tags appears in consistent sizes on Indeed. |
<br> | Single line break. |
<p> | Paragraph. Indeed automatically inserts an empty line between paragraph tags. |
<ul> | Unordered, or bulleted, list. |
<li> | List item. |
<strong> | Strong, or bold, text. |
<em> | Emphasized, or italicized, text. |
| Simple table. |
| Node | Description |
|---|---|
| Bold text. |
| Inline text. By default, |
The <p> tag has positive top and bottom margins and padding by default. Do not override this.
About new element settings
#You can also use these optional elements.
- To list more than one keyword or image URL, separate them with commas.
- Indeed is rolling these elements out gradually, so it might not show every element you specify. For details, contact your Alliance Manager.
- When you add or change any element, tell Indeed so it can update its configuration.
Other notes
#- Update the feed at least once per day.
- Make sure the feed content matches the job detail page exactly.
- Don't include test jobs, job board jobs, or shopping mall jobs.
Formatting guidelines (Japan)
#Indeed supports these HTML tags:
| Tag | Description |
|---|---|
<b> | Bold text. |
| Headings. Note: Indeed shows all headings at the same size. |
<br> | Line break. |
<p> | Paragraph. Indeed adds a blank line between paragraphs. |
<ul> | Bulleted list. |
<li> | List item. |
<strong> | Bold text. |
<em> | Italic text. |
| Basic table. Indeed shows each cell on its own line. |
Indeed also supports these computed style nodes:
| Node | Description |
|---|---|
<font style="font-weight:bold">Some bold text</font> | Bold text. |
<div> <h2 style="display:inline">Label: </h2> Text </div> | Shows the heading inline. By default, |
Above and below paragraphs, use positive margin and padding values. This is the default for <p> tags.
Formatting example
#This job description uses the supported tags:
English
<description> <![CDATA[<h2 id="job_description">Job Description:</h2><ul><li>Do you have 1-3 years of sales experience?</li><li> Are you relentless at closing the deal? </li><li>Are you ready for an exciting and high-speed career in sales? If so, we want to hear from you!</li></ul><font style="font-weight:bold">Benefits</font><p>We provide competitive compensation, including stock options and a full benefit plan. As a fast-growing business, we offer excellent opportunities for exciting and challenging work. As our company continues to grow, you can expect unlimited career advancement! </p>]]></description>Japanese
<description> <![CDATA[<h2 id="job_description">仕事内容</h2><ul><li>1~3年のセールスの経験をお持ちの方。</li><li> 取引成立に向けて全力で挑める方。 </li><li>セールス業界で、急成長を続ける活気に満ちた環境でのキャリアをお探しの方。連絡をお待ちしています。</li></ul><font style="font-weight:bold">福利厚生</font><p>ストックオプションや充実した福利厚生など、魅力的な給与体系が用意されています。急成長を続ける企業として、私たちは面白味があってやりがいを感じられる仕事の機会を提供しています。成長を続ける弊社内には、キャリアアップできるさまざまなチャンスがあります。</p>]]></description>Publish the XML feed
#To publish and update your XML feed, use one of these methods:
- Give Indeed an XML URL to crawl.
- Give Indeed access to an FTP or SFTP site that your client hosts.
- Upload the file to an Indeed FTP server. Compressed files are recommended.
Important XML feed policy guidelines
#-
Include every job from your clients' career pages.
If the feed is missing jobs, Indeed might reject it or reduce job visibility.
-
Include all job details that job seekers can see on your clients' websites.
For example, if a career site shows salary, include the
<salary>element. If it doesn't, include the<salary />element with a blank value for each job. -
Link each job to a details page that job seekers can view without signing in.
-
Include only open roles that are actively hiring.
Common issues
#These common issues can cause Indeed to reject your XML feed or hide your jobs from search results:
Incomplete data
- If your feed is missing required data, Indeed might not approve it for launch.
Incorrect special character encoding
- Open the feed URL in your browser, view the source, and check that special characters such as brackets (
<>) display correctly. - Start the file with an XML declaration that sets the character encoding. UTF-8 is the most common, but you can use another encoding.
- Use only the characters that the XML standard (opens in a new window) allows.
Jobs are missing from the feed, or job counts differ between the feed and career sites
- Include every job for each client. The feed must include every job you publish on the web.
Jobs do not have unique reference numbers and locations
- Give every job a unique
<referencenumber>. Otherwise, the job loses visibility on Indeed. - If a reference number appears more than once, Indeed shows only the first job.
Region‑wide postings do not reflect region‑wide jobs
- Specify the location with at least
<city>,<state>, and<country>. - If you omit them, the job gets no organic visibility by default.
Job postings for multiple locations
- To post a job in more than one location, add one entry for each location.
- The entries can share
<url>and<requisitionid>, but each needs a unique<referencenumber>.
Job postings in multiple languages
- To post a job in more than one language, add one entry for each language.
- The entries can share
<url>and<requisitionid>, but each needs a unique<referencenumber>.
Incomplete or empty job descriptions
- Include all text about the job in
<description>, even text stored separately in your database, such as required qualifications.
Jobs that are scams or suspected scams
- Indeed excludes suspected scams. Write clear, complete job descriptions. Clients must be legitimate companies, and jobs must be open positions.
Outdated jobs
- Don't include outdated or inactive jobs. When a job is filled, remove it from the feed. If Indeed finds outdated or inactive jobs, you must fix the feed to keep using it.
Job quality issues
- Indeed can exclude jobs from search results if they don't follow the Job Posting Standards (opens in a new window), are missing required fields, or don't meet Indeed quality rules.
- Clients with questions about their postings can review Indeed Policies (opens in a new window) and contact the Employer Help Center (opens in a new window).
These errors are common in XML job elements:
| Element | Common errors |
|---|---|
<title> | Includes extra text, such as location, job type, shift, or catchphrases. |
<date> | Specifies a future date. Jobs with a future date might not be visible. A future date. |
<company> | For subsidiaries or franchises with several stores under one company, enter the simplest business or brand name that job seekers recognize. Don't include phonetic readings. (Example 1) If the company has a facility or salon name, use it. For Hair Salon XX, run by Corporation A: (Example 2) Don't add parentheses to the company name. (Example 3) Japan only. Don't use abbreviations such as (株) or (有). Enter only the official name, without department names. (Example 4) Japan only. Don't include phonetic readings. |
|
English: For "1234 Sunny Lane, Phoenix, AZ 85003": Japanese: 「東京都千代田区丸の内1-9-2グラントウキョウサウスタワー」の場合: |
<station> | Japan only. Use only the train station name. Put bus stop details in For example, for "Nearest Roppongi Station XX bus stop": Note: If the location is incorrect, Indeed can't load the job location. |
<description> | The content and order of Indeed search results show Use HTML formatting. |
<salary> | The salary. Put the salary breakdown, examples, and bonuses in Example: If the salary varies by experience: English: Japanese: Indeed can also find the salary in other elements. |
| All elements | If you rename an element, such as |
XML feed FAQ
#Your client credentials are an Indeed Apply API token and secret. Access these credentials in Partner Console.
Use the shared API secret, which has the Indeed Apply credential type.
Indeed computes a message signature with the HMAC-SHA1 algorithm and sends the signature in the X-Indeed-Signature HTTP header.
Indeed Apply sends a POST request to your postUrl with an HTTP header that you can use to verify the request's authenticity.
Today, EEO and demographic questions apply only to US-based jobs for EEO compliance.
Indeed supports qualification-type questions. These non-blocking questions let the applicant move to the next section in the apply flow even when the answer does not meet the qualification, and Indeed still delivers the application.
Use the Indeed Apply Questions tool to verify the syntax of your screener questions JSON file. The tool also shows how the screener questions appear in the Indeed Apply application flow.
Before you push a job or integration live, test your integration with the Indeed Apply XML configuration testing tool. On the Configurable Parameters tab, enter the relevant information to start testing the end-to-end apply flow.
For POST requests, an application is a duplicate when it has the same job ID and comes from the same job seeker email as an Indeed application within the last 120 days.
When you check for duplicates in your POST response, ignore applications that came from a source other than Indeed. Also, do not treat applications from the same job seeker email to a different job ID at the same company as duplicates.
For XML that Indeed crawls on a URL or hosts on an FTP server you provide, Indeed refreshes the job data four times a day at six-hour intervals, starting from the time of the last request. For Indeed-hosted FTPs, Indeed refreshes the XML feed when it receives a new file, as often as every two hours. More frequent file uploads can delay updates to the job data; if you see a delay in feed indexing, scale back the upload frequency.
As long as you include the standard fields, you can add any field, such as <branch_id>. If specific information must appear on Indeed, put it in the <description> field.
Indeed's visibility rules determine search results. The Search Quality team prioritizes jobs that are legitimate, unique, easy to apply for, and have detailed descriptions and locations.
If the data on the client site corresponds to a data target on Indeed, and the tags match the supported tags, the job appears on the search results page.
If a tag does not match an Indeed tag, visibility depends on factors such as the market, the device (desktop or mobile), and others.
If a tag contains information that must appear, ask the client to add the information inside the <description> tag.
Jobs that do not meet these criteria might not appear in search results. Confirm that your clients follow the Search Quality team's best practices for posting.
If clients have trouble finding their jobs on Indeed, contact Indeed for help.
Indeed requires a URL to the job description, not the apply page, for these reasons:
- If Indeed Apply fails, Indeed redirects the job seeker to the job URL.
- If a client opts out of Indeed Apply, job seekers still need a way to apply.
- The Indeed aggregation engine needs an active URL to confirm job content and activity.
For companies new to Indeed, or for new job sources from companies already on Indeed, Indeed requires a contact email address to verify the account and enable organic syndication.
Indeed does not always use the email address, but requires it for every job.
Provide the job in every language where an open position exists, as a unique job in the XML feed. If you reuse the reference number in the XML feed, Indeed shows only the first occurrence of the job.
Provide the job in every location where an open position exists. Indeed rejects region-wide postings that are not region-wide jobs from organic visibility. Each job must have a unique location, a unique reference number, and represent a unique job; otherwise, the job loses visibility on Indeed.
To post a state-wide job, send the state and country information by using those elements, and leave the <city> and <postalcode> elements blank.
Example: a statewide job in Texas:
<city> <![CDATA[]]></city><state> <![CDATA[TX]]></state><country> <![CDATA[US]]></country><postalcode> <![CDATA[]]></postalcode>Example: a statewide job in Tokyo:
<city> <![CDATA[]]></city><state> <![CDATA[東京都]]></state><country> <![CDATA[JP]]></country><postalcode> <![CDATA[]]></postalcode>To post a country-wide job, send the country using the <country> element, and send a blank value for <city>, <state>, and <postalcode>.
Example: a US nationwide job:
<city> <![CDATA[]]></city><state> <![CDATA[]]></state><country> <![CDATA[US]]></country><postalcode> <![CDATA[]]></postalcode>Example: a Japan nationwide job:
<city> <![CDATA[]]></city><state> <![CDATA[]]></state><country> <![CDATA[JP]]></country><postalcode> <![CDATA[]]></postalcode>Post jobs to the most specific and accurate location possible. All jobs must include all elements used in the feed, even if those elements are blank, as the examples show.
You can use the <city> or <state> elements to indicate that a job is fully remote by sending the value "remote". If you use this value, enter "remote" in both elements. Alternatively, enter "remote" in one element and leave the other blank. Do not enter "remote" in one element and a real location in the other element.
If you have a job that is fully remote but requires residency in a specific state, you can use the <remotetype> element in conjunction with the statewide posting schema.
Japan only. When posting remote jobs in Japan, leave <city> and <state> blank and use <remotetype>. If you have a fully remote job that requires residence in a specific prefecture, you can use the <remotetype> element in combination with the prefecture-wide posting schema.
Example: A fully-remote job in Texas:
<city> <![CDATA[]]></city><state> <![CDATA[TX]]></state><country> <![CDATA[US]]></country><postalcode> <![CDATA[]]></postalcode><remotetype> <![CDATA[Fully remote]]></remotetype>Example: A fully-remote job in Tokyo:
<city> <![CDATA[]]></city><state> <![CDATA[東京都]]></state><country> <![CDATA[JP]]></country><postalcode> <![CDATA[]]></postalcode><remotetype> <![CDATA[Fully remote]]></remotetype>Remote type values:
- Fully remote: The employee works remotely or from home.
- Hybrid remote: The employee works both in-office and remotely on a consistent basis.
Example: a fully remote job in the US:
<city> <![CDATA[Remote]]></city><state> <![CDATA[]]></state><country> <![CDATA[US]]></country><postalcode> <![CDATA[]]></postalcode><remotetype> <![CDATA[Fully remote]]></remotetype>Example: a fully remote job in Japan:
<city> <![CDATA[]]></city><state> <![CDATA[]]></state><country> <![CDATA[JP]]></country><postalcode> <![CDATA[]]></postalcode><remotetype> <![CDATA[Fully remote]]></remotetype>Example: a hybrid remote job in Austin, TX:
<city> <![CDATA[Austin]]></city><state> <![CDATA[TX]]></state><country> <![CDATA[US]]></country><postalcode> <![CDATA[78701]]></postalcode><remotetype> <![CDATA[Hybrid remote]]></remotetype>Example: a hybrid remote job in Minato, Tokyo:
<city> <![CDATA[港区三田]]></city><state> <![CDATA[東京都]]></state><country> <![CDATA[JP]]></country><postalcode> <![CDATA[100-8602]]></postalcode><remotetype> <![CDATA[Hybrid remote]]></remotetype>You cannot. Indeed Apply applies to every job on the client account. Clients can opt out of Indeed Apply at the account level, but not at the job level.
Steps and considerations:
- Opt in from your ATS: Opt in or opt out of Indeed Apply directly from your ATS platform. For help, contact your ATS.
- Troubleshooting: If Indeed Apply does not work as expected, confirm the client opted in. If issues persist, gather examples of jobs that do not show Easy Apply and contact Indeed support.
Use the <state> field for Japanese prefectures.
You can invite the job seeker to visit your site, but you cannot require additional questions to complete the application.
The X-Indeed-Signature header authenticates every POST request from Indeed and is always required. Indeed returns HTTP 401 when the signature does not match.
See also
#Guides
#- HTML entities (opens in a new window) — Explains what HTML entities are. Don't use them in XML feeds.
- How to Display Pay Information in Job Postings (opens in a new window) — Explains how to show pay in jobs.
- How to post a remote job on Indeed (opens in a new window) — Explains how to post remote jobs. Also available in Japanese (opens in a new window).
References
#- Additional API Terms and Guidelines — Lists the terms that apply to Indeed Apply and Job Sync integrations.
- ISO 8601 (opens in a new window) — Describes the date and time format for the
<date>element. - Job Posting Standards (opens in a new window) — Lists the standards that every job on Indeed must meet.
- Misleading Content and Activities (opens in a new window) — Explains which job content Indeed considers misleading.
- Policies (opens in a new window) — Lists Indeed's policies for employers.
- XML standard (opens in a new window) — Lists the characters that are valid in XML.
Tools and support
#- Employer Help Center (opens in a new window) — Contact Indeed employer support.
- Indeed + Your ATS (opens in a new window) — Describes how ATS partners integrate with Indeed.
- Indeed Partners (opens in a new window) — Contact Indeed about working with Indeed as an ATS partner.