Employer Registration API guide

Register employers to manage feature settings and sync candidate data between their ATS and Indeed.

 

legal notice

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

Call the Employer Registration API to register employers for Candidate Sync integration. Registration enables employers to manage feature settings and sync candidate data between their ATS and Indeed.

Employer Registration API workflow

After you integrate with the Employer Registration API, you can call these operations:

1. 1.
   Authenticate.
2. 2.
   Register employer: Register an employer, and return information about the registration.
3. 3.
   Update registration: Update a registration to enable or disable features.
4. 4.
   List registrations: List an employer's registrations.
5. 5.
   Deregister employer: Delete a registration and disable its features.
6. 6.
   Troubleshoot GraphQL errors.

Employer Registration API references

• registerEmployer: Register an employer, and return information about the registration.
• manageFeaturesForEmployer: Update the registration to enable or disable features.
• findRegisteredEmployers: List registrations by ATS employer identifier.
• deregisterEmployer: Delete a registration.

Authenticate

When you become an Indeed partner, Indeed sets up an app for your integration. Log in to Partner Console to view your app and OAuth credentials (client ID, secret, and authorization code for 3-legged OAuth). Exchange credentials for an access token to authenticate API calls.

Each Candidate Sync API operation requires an OAuth token:

OAuth token types for Candidate Sync API operations

API / operations	OAuth token type
Employer Registration API Register an employer	Authentication Authenticate with a 3-legged OAuth token that represents an employer with the employer.ats_candidate.sync scope. This token links the employer's Indeed account to their ATS account. An Indeed administrator or owner must create it. If registerEmployer returns a missing scope error, the token might not be associated with an employer. See 3-legged OAuth token that represents an employer.
Employer Registration API Update a registration List registrations Deregister an employer Send Candidates API Initialize application and upload attachments Submit application Track application status Delete application Retrieve Candidates API Get unacknowledged assets Get assets by time range Create test assets	Authentication Authenticate with a 2‑legged OAuth token. Your application authenticates directly with Indeed's authorization server without user interaction. See 2‑legged OAuth token.

Securely store access tokens in your ATS, and don't share them between users. Indeed trusts that your system is the source of truth for a job. If you use a user's access token for a job that another user posted, Indeed might grant that user access to the other user's job on Indeed.

After you get an access token, include this token in the query or mutation. Indeed recommends that you refresh your access tokens before they expire to avoid asking users to log in every time they need to view updated job statuses.

See Integrate with Indeed and call APIs and Scopes.

Register employer

Request – Register employer

To register an employer and return registration information, call registerEmployer.

Authentication

Authenticate with a 3-legged OAuth token that represents an employer with the employer.ats_candidate.sync scope. This token links the employer's Indeed account to their ATS account. An Indeed administrator or owner must create it.

If registerEmployer returns a missing scope error, the token might not be associated with an employer.

See 3-legged OAuth token that represents an employer.

Provide these input fields:

registerEmployer input fields

Field	Required	Description
partnerEmployerId Type: ID!	✅	Partner-provided ID that uniquely identifies the employer. You can register one partnerEmployerId with multiple Indeed accounts, but each Indeed account supports only one partnerEmployerId per ATS. Using a different partnerEmployerId with the same Indeed account updates the registration to the specified atsName and partnerEmployerId.
atsName Type: String!	✅	Partner-provided name the employer uses. Employers on Indeed see this name.

Response – Register employer

The response returns EmployerRegistration. Save the registration id for subsequent Candidate Sync API calls, or look it up later with findRegisteredEmployers by partnerEmployerId.

Update registration

Request – Update registration

To enable or disable features for an employer registration, call manageFeaturesForEmployer.

Authentication

Authenticate with a 2‑legged OAuth token. Your application authenticates directly with Indeed's authorization server without user interaction.

See 2‑legged OAuth token.

Provide these input fields:

manageFeaturesForEmployer input fields

Field	Required	Description
indeedRegistrationId Type: ID!	✅	Unique ID for the ATS-employer registration. Set this value to the id returned by registerEmployer.
features Type: EmployerRegistrationFeaturesInput!	✅	Features to update. Omitted features and features updated to their current status remain unchanged. Duplicates are not allowed. Set these features to DISABLED or ENABLED: retrieveSourcedCandidatesClick: RetrieveSourcedCandidates.OneClick feature status. retrieveSourcedCandidatesAuto: RetrieveSourcedCandidates.AutomatedTransfers feature status. sendApplications: SendApplications feature status.

Response – Update registration

The response returns EmployerRegistration.

List registrations

Request – List registrations

Call FindRegisteredEmployers to list an employer's registrations and get the registration ID for use in manageFeaturesForEmployer and deregisterEmployer.

Authentication

Authenticate with a 2‑legged OAuth token. Your application authenticates directly with Indeed's authorization server without user interaction.

See 2‑legged OAuth token.

Provide these input fields:

FindRegisteredEmployers input fields

Field	Required	Description
partnerEmployerId Type: ID!	✅	Partner-provided ID that uniquely identifies the employer. Use this value to list an employer's registrations.
indeedRegistrationId Type: ID	⬜	ATS-employer registration ID. Use this value to show a specific registration. Set this value to the id returned by registerEmployer.

Response – List registrations

Returns an array of EmployerRegistration objects matching the filter.

Deregister employer

Request – Deregister employer

To delete a registration and disable its features, call deregisterEmployer.

Authentication

Authenticate with a 2‑legged OAuth token. Your application authenticates directly with Indeed's authorization server without user interaction.

See 2‑legged OAuth token.

Also deletes any employer or candidate data transmitted to Indeed through this registration.

Provide this input field:

deregisterEmployer input field

Field	Required	Description
indeedRegistrationId Type: ID!	✅	ATS-employer registration ID. Set this value to the id returned by registerEmployer.

Deregistration is permanent. You cannot recover the registration or its stored candidate data. Employers can reregister to get a new registration ID.

Response – Deregister employer

Returns the DeregisterEmployerPartnerAtsSyncEmployerRegistrationPayload object.

Troubleshoot errors

To troubleshoot:

• OAuth errors that can occur before you access GraphQL, see Troubleshoot OAuth errors.

• GraphQL errors, see Troubleshoot GraphQL errors.

• Issues that occur when posting jobs, see Why don't my jobs appear on Indeed?.

 

Was this page helpful?