Retrieve Candidates API integration guide

Integrate the Retrieve Candidates API.

 

legal notice

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

Integration workflow

To integrate the Retrieve Candidates API:

Integrate the Retrieve Candidates API

#	Step
1.	Sign a Developer Agreement with Indeed.
2.	Ask Indeed to register your app as part of the onboarding process. After Indeed has registered your app, you can use Partner Console to access your OAuth credentials: a client ID and secret. See Partner Console Credentials.
3.	Develop and test your integration.
4.	Get approval for your integration.

Develop and test your integration

1. Build an ATS UI for employers to retrieve candidates and resumes, acknowledge candidates, and receive new candidates.

2. Validate that:

   • You do not receive any Common GraphQL error codes when retrieving candidates.
   • You can retrieve candidates.
   • You can download candidates' resumes.
   • You can acknowledge candidates and receive new candidates.

Retrieve ATS candidates mockup

Retrieve ATS candidates mockup

Get approval for your integration

Demonstrate the full integration flow live or in a recorded video:

1. Create a registration.
2. Verify the registration is visible in the ATS UI with a disable button.
3. Disable the registration to remove it.
4. Create a second registration.
5. Use stageAssets to create a mock asset for the second registration.
6. Verify the mock asset appears in the ATS within 5 minutes with correct source attribution (optional). At minimum, the email, name, and resume must be visible.
7. Disable the registration from Indeed's UI. The candidate remains in the ATS, but any registration indicators disappear.

Indeed sends an email notification after approving your integration.

 

Was this page helpful?