Sponsored Jobs API scopes for ATS integrations

OAuth scopes for the Sponsored Jobs endpoints, including ATS-only endpoints.

 

legal notice

Unless you have a written agreement with Indeed regarding your use of Indeed's APIs, by using this API or its documentation, you agree to apply the Indeed API Terms and the Additional API Terms and Guidelines to your use of Indeed's APIs.

Account management

Account management scopes

API endpoint	OAuth scope	Access token type
Get Indeed advertiser account information for employer GET /v1/account	For employer accounts: employer.advertising.account.read with the employer_access scope	Employer access token
	For master accounts: employer.advertising.account.read	Access token without employer parameter
List advertiser subaccounts GET /v1/advertisers	employer.advertising.account.read	Access token without employer parameter
Create advertiser subaccount POST /v1/subaccounts	employer.advertising.subaccount	Access token without employer parameter
Get monthly jobs budget GET /v1/account/budget	employer.advertising.account.read with the employer_access scope	Employer access token
Update monthly jobs budget PATCH /v1/account/budget	employer.advertising.account with the employer_access scope	Employer access token
List employer accounts GET /v1/advertisers	employer.advertising.subaccount.read	Access token without employer parameter. Supports 2-legged and 3-legged grants.
Get credit allocation and balance GET /v1/advertisers/credits	employer.advertising.account.read	Employer access token

Campaign management

For these endpoints, get an access token with the employer_access scope. See Get an employer access token.

Campaign management scopes

Verb	API endpoint	OAuth scope and access token type
List employer campaigns and statuses GET /v1/campaigns	employer.advertising.campaign.read	Employer access token
Create campaign POST /v1/campaigns	employer.advertising.campaign.read	Employer access token
Get general campaign information GET /v1/campaigns/:campaignId	employer.advertising.campaign.read	Employer access token
Update general campaign information PATCH /v1/campaigns/:campaignId	employer.advertising.campaign.read	Employer access token
Get campaign budget and duration GET /v1/campaigns/:campaignId/budget	employer.advertising.campaign.read	Employer access token
Update campaign budget and duration PATCH /v1/campaigns/:campaignId/budget	employer.advertising.campaign.read	Employer access token
Get job count for campaign GET /v1/campaigns/:campaignId/jobCount	employer.advertising.campaign.read	Employer access token
Get details for jobs in campaign GET /v1/campaigns/:campaignId/jobDetails	employer.advertising.campaign.read	Employer access token
Get key dates for employer campaign GET /v1/campaigns/:campaignId/properties	employer.advertising.campaign.read	Employer access token

Reports

For these endpoints, get an access token with the employer_access scope. See Get an employer access token.

Reports scopes

API endpoint	OAuth scope	Access token type
Get campaign statistics, for date range GET /v1/campaigns/:campaignId/stats	employer.advertising.campaign_report.read	Employer access token

Detailed reports

For these endpoints, get an access token with the employer_access scope. See Get an employer access token.

Detailed reports scopes

API endpoint	OAuth scope	Access token type
Get campaign traffic report by campaign and job, for date range GET /v1/stats	employer.advertising.campaign_report.read	Employer access token
Get detailed campaign traffic report GET /v1/stats/:reportId	employer.advertising.campaign_report.read	Employer access token

Campaign predictions

Campaign predictions scopes

API endpoint	OAuth scope	Access token type
Get campaign predictions POST /v1/campaignpredictions	employer_access	Employer access token

Organic job predictions

Organic job predictions scopes

API endpoint	OAuth scope	Access token type
Get organic job performance and prediction POST /v1/organicjobpredictions	employer_access	Employer access token

 

Was this page helpful?