Glossary
Common terms and definitions for Indeed partner integrations.Filter by category
Filter by product
Filter by OAuth flow
100 terms
#
2-legged OAuth
Authentication flow where the application authenticates directly without user involvement using a client ID and secret (client credentials flow).OAuth flow:
2-legged
Learn more:Set up 2-legged OAuth
3-legged OAuth
Authentication flow that involves user authorization, allowing the application to act on behalf of a user (authorization code flow).OAuth flow:
3-legged
Learn more:Set up 3-legged OAuth
A
Access token
A credential used to authenticate API requests. Exchange your OAuth credentials for an access token, then include it on API calls. Access tokens expire after one hour.OAuth flow:
2-legged
3-legged
Learn more:OAuth reference
Acknowledgment token
A token returned by the Retrieve Candidates API's fetchAssets operation. Include it in the next fetchAssets call to acknowledge the current batch and request the next batch of candidate assets.Advertiser
An entity that sponsors jobs on Indeed. In Job Update API and Sponsored Jobs API flows, an access token represents an advertiser rather than an employer.Advertiser ID
Unique identifier for an advertiser on Indeed. Associate your access token with an advertiser ID (instead of an employer ID) for Job Update and Sponsored Jobs API operations.Learn more:Job Update API guide
API (Application Programming Interface)
A set of protocols and tools that allow different software applications to communicate with each other.API token
A unique identifier used for tracking and delivery authentication.Indeed Apply
A unique identifier used for tracking and delivery authentication in Indeed Apply systems. The client ID generated for an Indeed Apply credential type serves as your API token.
App (application)
In Partner Console, an app represents the integration of Indeed APIs and services with your product. Not to be confused with a job application.OAuth flow:
2-legged
3-legged
Learn more:OAuth glossary: App
Application version
A staged version of a candidate application in the Send Candidates API. Each call to initialize creates a new version identified by an applicationVersionId.Apply with Indeed (AWI)
An integration that adds an Apply with Indeed button to jobs posted through the Job Sync API or XML feed. Job seekers apply using their saved Indeed profile data without leaving your site.Learn more:Apply with Indeed guide
ApplyID
A string of uppercase letters and digits appended to each URL when job seekers click through to career sites. It uniquely identifies the application so Indeed can track it and receive disposition data.ATS (Applicant tracking system)
Software used by employers to manage job postings, applications, and candidate tracking throughout the hiring process.ATS type
A value that uniquely identifies your ATS within the Indeed system. Indeed assigns this value during onboarding. Use it in the EmployerIdentifiersInput.type field for Employer Data API calls.Authentication
The process of verifying your app's identity. Exchange your OAuth credentials for an access token, then include it on API calls to authenticate your app's identity and permissions.OAuth flow:
2-legged
3-legged
C
Candidate Sync APIs
A collection of APIs for synchronizing candidate data between Indeed and your system, including Employer Registration, Send Candidates, and Retrieve Candidates APIs.Related:Employer Registration API·Send Candidates API·Retrieve Candidates API·Disposition·ATS (Applicant tracking system)
Learn more:Candidate Sync APIs guide
Client credentials
OAuth 2.0 authentication method where the application authenticates directly with the API using a client ID and secret (2-legged OAuth). Does not require user interaction.OAuth flow:
2-legged
Client ID and secret
OAuth credentials generated when you become an Indeed partner. Access your client ID and secret in Partner Console. Use them to authenticate your app with Indeed APIs.OAuth flow:
2-legged
3-legged
Learn more:OAuth glossary: Client ID and secret
Company name
The name of the company advertising the job. Used in Indeed Apply metadata to identify the employer on the application.Cover letter
A document submitted by a job seeker along with their resume as part of a job application.Related:Job application
Credential type
The type of credential to request for your app. Options include OAuth 2.0 (generates a client ID and secret for API access) and Indeed Apply (generates an Indeed Apply API token).OAuth flow:
2-legged
3-legged
D
Disposition
The status of a candidate in the hiring process, such as applied, reviewed, interviewed, hired, or rejected.Disposition Sync
A standardized status value sent via the Disposition Sync API to update Indeed on a candidate's progress through the hiring pipeline.
Disposition data
Any update to an application in your ATS, including actions a recruiter or hiring manager takes after a candidate applies, such as contacting, interviewing, offering a position, rejecting, or hiring.Disposition Sync API
API that allows partners to send candidate status updates back to Indeed, keeping job seekers informed about their application progress.Learn more:Disposition Sync API guide
E
Employer Data API
API for creating and managing employer entities on Indeed. Required before posting jobs on behalf of employers.Learn more:Employer Data API guide
Employer ID
Unique identifier for an employer entity on Indeed, returned by the Employer Data API. Use in the employer parameter to associate an access token with that employer.OAuth flow:
2-legged
3-legged
Employer integration
The configuration data for delivering applications to employers through Indeed Apply.Employer Job ID (EJID)
An encoded form of the sourcedPostingId in IRI format that Indeed provides to partners. Used as an alternate job identifier in Disposition Sync and Job Sync API operations.Learn more:Disposition Sync API guide
Employer Registration API
API for registering and managing employer accounts in the Candidate Sync system. Returns a registration ID used with the Send Candidates and Retrieve Candidates APIs.Learn more:Employer Registration API guide
Employer selection screen
Indeed-hosted screen that enables a user to select an employer from a list of employers associated with the user.OAuth flow:
2-legged
3-legged
External job ID
The job identifier used by an employer's integration system, distinct from Indeed's internal job identifiers.Related:Job metadata
G
Grant type
How the OAuth client is authorized. Authorization code grant type authorizes your app to act on behalf of a user (3-legged). Client credentials grant type authorizes your app to act on behalf of itself (2-legged).OAuth flow:
2-legged
3-legged
GraphQL
A query language and runtime for APIs that allows clients to request exactly the data they need. Most Indeed partner APIs use GraphQL.Learn more:GraphQL at Indeed
H
HTML configuration
The setup of Indeed Apply metadata using HTML, as an alternative to XML configuration.Learn more:Add Indeed Apply
I
ID token
Base64-encoded JSON Web Token (JWT) received automatically when you get an access token. Proves that the user has been authenticated and contains information about the current user.OAuth flow:
3-legged
Learn more:OAuth reference: User info response fields
Identity provider (IdP)
The system that manages user identities and authenticates users. In SCIM integrations, the IdP synchronizes user data with Indeed as the service provider.Indeed Apply
Indeed's streamlined application process that allows job seekers to apply using their Indeed profile and resume, reducing friction and increasing application volume.Learn more:Indeed Apply guide
Indeed Apply API token
Enables you to mark your jobs with the Easily Apply label and enables job seekers to apply without leaving Indeed. The client ID generated for an Indeed Apply credential type serves as your API token.OAuth flow:
2-legged
3-legged
Indeed Apply ID
An Indeed-assigned unique ID for Indeed Apply jobs. Used to reference the candidate and the job.Indeed Apply metadata
Metadata that defines the identity of a job, display details, apply configuration, and delivery instructions. Metadata can be in the form of HTML or XML.Learn more:Add Indeed Apply
Indeed crawler
Automated programs that Indeed uses to discover and index jobs from public websites. The two Indeed crawlers are Indeedbot and Indeedshopbot.Learn more:About Indeed crawlers
Indeed job key
An Indeed-assigned job identifier (indeedJobKey) used as an alternate job identifier in Disposition Sync API operations. Takes priority over employer Job ID and ATS application identifier.Learn more:Disposition Sync API guide
Indeed job seeker key
An Indeed-assigned identifier for a job seeker (indeedJobSeekerKey), used in the jobSeekerIdentifier field of Disposition Sync API operations.Indeed PLUS
Multi-site job distribution platform for the Japan market, offering API and JavaScript plugin integrations to post jobs across multiple Japanese job sites.Learn more:Indeed PLUS guide
Indeed registration ID
An employer identifier returned by the Employer Registration API (indeedRegistrationId). Required for Send Candidates API mutations to identify the employer on Indeed.IRI (Indeed Resource Identifier)
A globally unique identifier that references an entity resolved by OneGraph. IRIs ensure GraphQL id values are unique and work with the Node interface. Format: iri://{context}/{entityType}/{internalId}.Learn more:Indeed Resource Identifiers (IRIs)
ITTK
Indeed Tracking Token Key. Used to track job applications sourced by Indeed.J
Job application
A submission by a job seeker applying for a position. Not to be confused with an OAuth app.Job feed
A file (typically XML) containing job listings that can be uploaded to Indeed for job posting.Job location
The geographic location of the job being advertised, used in job metadata and Indeed Apply configuration.Related:Job metadata
Job metadata
Data that includes job title, company name, job location, and other details about a job posting.Job posting surface status
A status that describes whether a job posting is active on a given surface. If isRejected is true, the job does not appear in search results.Learn more:Job Update API guide
Job seeker
A person searching for employment opportunities on Indeed.Job Sync API
The primary API for posting and managing job listings on Indeed and Indeed PLUS.Learn more:Job Sync API guide
Job Update API
Lightweight API for updating existing jobs on Indeed using your ATS job ID, without requiring Indeed's job posting ID.Related:Job Sync API
Learn more:Job Update API guide
L
Locale
The language and regional settings used during the application process, determining the language of the Indeed Apply experience.Related:Indeed Apply
Log in with Indeed
An authentication feature that enables users to sign in to your site with their Indeed credentials using 3-legged OAuth.Learn more:Log in with Indeed guide
M
Moderation
Indeed's review process for employer data submitted through the Employer Data API. Indeed reviews all employer data for completeness and appropriateness.Related:Employer Data API
O
OAuth (Open Authorization)
Industry-standard protocol for secure API authentication. Indeed uses OAuth 2.0 for partner API access.Learn more:Authorization guide
OAuth app
An OAuth client. For an app in the general sense, see app. Not to be confused with a job application.OAuth flow:
2-legged
3-legged
OAuth consent screen
Indeed-hosted screen that enables a user to grant consent for scopes requested by the OAuth app, such as the employer_access scope.OAuth flow:
3-legged
OAuth credentials
Also known as API credentials. When you become an Indeed partner, Indeed sets up an app. Access your app's OAuth credentials (a client ID and secret) in Partner Console.OAuth flow:
2-legged
3-legged
OneGraph
Indeed's unified GraphQL gateway that resolves IRIs to their entities. Partner API requests go through OneGraph to access Indeed data.Learn more:GraphQL at Indeed
P
Partner API token
Credentials for the Apply with Indeed (AWI) integration, separate from the Indeed Apply API token. Access as Apply With Indeed Token in Partner Console.Learn more:Apply with Indeed guide
Partner Console
Indeed's web portal for managing API credentials, testing integrations, and accessing partner support.Learn more:Get started
Partner employer ID
A value that uniquely identifies an employer's account in your ATS (partnerEmployerId). Set this during employer registration. One partnerEmployerId can map to multiple Indeed accounts.Learn more:Employer Registration API guide
Partner ID
Unique identifier assigned to partner organizations integrating with Indeed APIs.Related:Partner Console
POST URL
A URL endpoint used to deliver job applications to employers through Indeed Apply.Primary user
Sets up and has full access to all resources associated with the Indeed employer account. Creates secondary users and manages their permissions.OAuth flow:
2-legged
3-legged
Public client
A client that cannot maintain the confidentiality of its credentials, such as a native app or browser-based app. Public clients can use the authorization code grant type only.OAuth flow:
3-legged
R
Rate limiting
Restrictions on the number of API requests that can be made within a specific time period to ensure fair usage and system stability.Real-time API
Server-sent events (SSE) API that streams real-time updates about applications and events, providing instant notifications without polling.Learn more:Real-time API guide
Redirect URL
Page on your website where Indeed redirects a user after trying to authorize your app. If the user authorized your app, Indeed passes an authorization code to your redirect URL.OAuth flow:
3-legged
Refresh token
Received with your access token when you request the offline_access scope. Use the refresh token to get a new access token. Refresh tokens are valid for 60 days, extended with each refresh.OAuth flow:
3-legged
Registration ID
An identifier returned by the Employer Registration API's registerEmployer operation. Use it with manageFeaturesForEmployer, FindRegisteredEmployers, and deregisterEmployer operations.Learn more:Employer Registration API guide
Resource group
In SCIM, a group that isolates provisioned users from Indeed.com users. Resource groups let the third-party system manage user lifecycle without users creating Indeed accounts.Retrieve Candidates API
API for retrieving candidate data from Indeed, including interested candidates from Smart Sourcing. Uses a batch polling model with fetchAssets and acknowledgment tokens.Learn more:Retrieve Candidates API guide
S
Sandbox mode
A testing mode in the Retrieve Candidates API that creates test candidate assets using the stageAssets operation. Test assets behave like real candidate data for integration testing.SCIM (System for Cross-domain Identity Management)
API standard for provisioning user access to Indeed tools and services, allowing automated user management.Learn more:SCIM API guide
Scopes
Permissions that a user grants to your app. Request scopes when you request an access token.OAuth flow:
2-legged
3-legged
Screener question testing tool
A tool used to test screener questions for Indeed Apply before deploying them in production.Related:Indeed Apply
Secondary user
User that a primary user creates and grants permissions to on an Indeed employer account.OAuth flow:
2-legged
3-legged
Related:Primary user
Send Candidates API
API for sending candidate application data from your ATS to Indeed. Requires an indeedRegistrationId from the Employer Registration API.Learn more:Send Candidates API guide
Service provider (SP)
In SCIM integrations, the system that receives user data from the identity provider. Indeed acts as the service provider.Simulated environment
Indeed's testing environment for GraphQL APIs that allows partners to test integrations without affecting production data.Related:GraphQL
Learn more:Simulated environment guide
Smart Sourcing
Indeed's feature for matching interested candidates to open positions. The Retrieve Candidates API returns Smart Sourcing candidates through the fetchAssets operation.Source name
The sourceName field in the Job Sync API that identifies a group of jobs managed together for a role, such as a parent organization. Must be unique across all job groups.Learn more:Job Sync API guide
Sourced job posting
A job posting created through the Job Sync API, as opposed to jobs posted directly by employers through Indeed's UI.Related:Job Sync API
Sourced posting ID
A unique identifier (sourcedPostingId) that Indeed returns for each accepted job posting in the Job Sync API. Use this value to expire or update the job. Returns null if the posting is rejected.Learn more:Job Sync API guide
SUID (Standardized Unique Identifier)
A five-character alphanumeric code that standardizes how jobs and employers are classified, covering job types, occupations, work systems, attributes, and employer sectors.Learn more:SUIDs
T
Tenant
For Indeed PLUS, a unique Identity Provider (IdP) and its associated users.OAuth flow:
2-legged
3-legged
Related:Indeed PLUS
Token
A secure credential used for API authentication. OAuth tokens have limited lifespans and must be refreshed periodically.Token exchange
OAuth grant type that allows exchanging one type of token for another, used in specific integration scenarios.Trusted domain
A domain registered with Indeed as authorized to use the Real-time API. Add your application's domain as a trusted domain during onboarding.Related:Real-time API
U
Universal Apply ID
A unique identifier for a job application in a standard format. Can be an Indeed Apply ID, ITTK, or ApplyID depending on the application source.Learn more:Disposition Sync API guide
W
Webhook
An HTTP POST request that Indeed sends to partner endpoints to deliver event notifications in real time. Webhooks follow the CloudEvents specification and include an Indeed signature for verification.Related:GraphQL
Learn more:Webhooks guide
X
XML configuration
The setup of Indeed Apply metadata using XML, as an alternative to HTML configuration.Learn more:Add Indeed Apply