Integration basics

GraphQL basics, best practices, and reference data for Indeed APIs.

Overview

Indeed GraphQL APIs let you request only the data you need. This section covers GraphQL basics, best practices, webhooks, and standardized unique identifiers (SUIDs), plus links to each API’s integration guide.

GraphQL at Indeed

Call Indeed’s GraphQL endpoint, follow best practices, receive webhooks, and fix errors.

• GraphQL at Indeed — Authenticate and call Indeed GraphQL APIs.
• Best practices for GraphQL clients — Best practices for developing quality APIs at Indeed.
• Indeed Resource IDs (IRIs) — Look up entities by IRI through the Node interface.
• Webhooks guide — Integrate webhooks to deliver events to your endpoints.
• Troubleshoot GraphQL errors — Read error codes, messages, and status codes in GraphQL responses.

SUIDs

Classify jobs and employers with five-character codes for types, occupations, and attributes.

• SUIDs — Standardized five-character codes that classify jobs and employers by type, occupation, and attributes.
• SUID reference — All SUID tables in one place.
• SSUID change log — Additions and changes to SUID reference tables.

API integration guides

Each of these Indeed APIs has one or more integration guides.

• Candidate Sync APIs
  • Employer Registration API integration guide — Integrate the API to register employers to sync candidate data and manage feature settings between their ATS and Indeed.
  • Send Candidates API integration guide — Integrate the API to sync candidate applications with Indeed.
  • Retrieve Candidates API integration guide — Integrate the API to get candidate information from Indeed for employers.
• Disposition Sync API
  • Integrate the Disposition Sync API — Integrate the API to send job application disposition data to Indeed.
• Hiring Lab API
  • Integrate the Hiring Lab API
• Indeed Apply
  • Direct employers and agencies building Indeed Apply through XML start here
  • Approved partners building Indeed Apply through Job Sync API start here
• Indeed PLUS (Japan)
  • Employer Data API > Quick start — Create and update employer entities on Indeed and the Indeed PLUS platform. Not available for direct employers.
  • ATS JavaScript Plugin > Load the plugin script — To integrate the ATS JavaScript Plugin into your ATS site, load the plugin script.
• Job Sync API
  • Integrate the Job Sync API — Integrate the API to create and manage job postings on Indeed.

Related resources

• Get started — Set up your integration and make your first API call.
• Authentication — Configure OAuth and manage access tokens.
• GraphQL API reference — Complete reference for Indeed's GraphQL schema.

---

 

Was this page helpful?