Sponsored Jobs API scopes

OAuth scopes reference for the Sponsored Jobs 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.

A scope value is required when generating the auth token for each API call.

• Requesting a write scope also grants the permissions of the corresponding read-only scope.

  For example, employer.advertising.campaign also grants the permissions that employer.advertising.campaign.read grants.

• You can associate multiple scopes with one access token. Space-delimit the scopes.

  For example employer_access employer.advertising.campaign employer.advertising.campaign_report.read.

In your OAuth authorization code request, pass the scopes that correspond to the API endpoints you are calling.

Then, the end user chooses whether to grant you none, some, or all scopes that you requested.

Use this table to determine which scope to request for each API endpoint.

API quota usage

For this endpoint, get an access token with the employer_access scope. See Get access token that represents employer.

API quota usage

Verb	API endpoint	OAuth scope
GET	/v1/apiquotausage	employer.advertising.account.read

Account management

Account management scopes

Verb	API endpoint	OAuth scope	Access token type
GET	/v1/account	For employer account: employer.advertising.account.read	With employer_access scope. See Get access token that represents employer.
		For master account: employer.advertising.subaccount.read	Without employer parameter
GET	/v1/subaccounts	employer.advertising.subaccount.read	Without employer parameter
POST	/v1/subaccounts	employer.advertising.subaccount	Without employer parameter
GET	/v1/account/budget	employer.advertising.account.read	With employer_access scope. See Get access token that represents employer.
PATCH	/v1/account/budget	employer.advertising.account	With employer_access scope. See Get access token that represents employer.

Campaign management

For these endpoints, the access token type with the employer_access scope. See Get access token that represents employer.

Campaign management scopes

Verb	API endpoint	OAuth scope
GET	/v1/campaigns	employer.advertising.campaign.read
POST	/v1/campaigns	employer.advertising.campaign
GET	/v1/campaigns/{campaignId}	employer.advertising.campaign.read
PATCH	/v1/campaigns/{campaignId}	employer.advertising.campaign
GET	/v1/campaigns/{campaignId}/budget	employer.advertising.campaign.read
PATCH	/v1/campaigns/{campaignId}/budget	employer.advertising.campaign
GET	/v1/campaigns/{campaignId}/jobCount	employer.advertising.campaign.read
GET	/v1/campaigns/{campaignId}/properties	employer.advertising.campaign.read

Reports

For these endpoints, the access token type with employer_access scope. See Get access token that represents employer.

Reports scopes

Verb	API endpoint	OAuth scope
GET	/v1/campaigns/{campaignId}/stats	employer.advertising.campaign_report.read
GET	/v1/campaigns/{campaignId}/stats/{date}	employer.advertising.campaign_report.read
GET	/v1/campaigns/{campaignId}/stats/entryDates	employer.advertising.campaign_report.read
GET	/v1/stats	employer.advertising.campaign_report.read
GET	/v1/stats/{reportId}	employer.advertising.campaign_report.read

 

Was this page helpful?