Sponsored Jobs API scopes for direct integrations
OAuth scopes reference for the Sponsored Jobs endpoints.
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.
You must request at least one scope when you get an access token.
- A write scope includes the matching read-only scope. For example,
employer.advertising.campaignalso includesemployer.advertising.campaign.read. - You can request multiple scopes in one access token. See the Glossary. Separate them with spaces. For example:
employer_access employer.advertising.campaign employer.advertising.campaign_report.read
In your OAuth authorization code request, include the scopes for the API endpoints you want to call. The end user can grant none, some, or all of them. See the Glossary.
Use these tables to find the right scope for each API endpoint.
API quota usage
| API endpoint | OAuth scope | Access token type |
|---|---|---|
Get advertiser's API quota usage | employer.advertising.account.read | Employer access token |
API access
| API endpoint | OAuth scope | Access token type |
|---|---|---|
Update advertiser's API access | employer.advertising.account | Employer access token |
Account management
| API endpoint | OAuth scope | Access token type |
|---|---|---|
Get Indeed advertiser account information for employer |
| Employer access token |
List advertiser subaccounts | employer.advertising.subaccount.read | Access token without |
Create advertiser subaccount | employer.advertising.subaccount | Access token without |
Get monthly jobs budget | employer.advertising.account.read | |
Update monthly jobs budget | employer.advertising.account | |
List employer accounts | employer.advertising.subaccount.read | Access token without employer parameter. Supports 2-legged and 3-legged grants. |
Get credit allocation and balance | 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.
| Verb | API endpoint | OAuth scope and access token type |
|---|---|---|
List employer campaigns and statuses | employer.advertising.campaign.read | Employer access token |
Create campaign | employer.advertising.campaign | Employer access token |
Get general campaign information | employer.advertising.campaign.read | Employer access token |
Update general campaign information | employer.advertising.campaign | Employer access token |
Get campaign budget and duration | employer.advertising.campaign.read | Employer access token |
Update campaign budget and duration | employer.advertising.campaign | Employer access token |
Get job count for campaign | employer.advertising.campaign.read | Employer access token |
Get details for jobs in campaign | employer.advertising.campaign.read | Employer access token |
Get key dates for employer campaign | 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.
| API endpoint | OAuth scope | Access token type |
|---|---|---|
Get campaign statistics, for date range | 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.
| API endpoint | OAuth scope | Access token type |
|---|---|---|
Get campaign traffic report by campaign and job, for date range | employer.advertising.campaign_report.read | Employer access token |
Get detailed campaign traffic report | employer.advertising.campaign_report.read | Employer access token |
Campaign predictions
| API endpoint | OAuth scope | Access token type |
|---|---|---|
Get campaign predictions | employer_access | Employer access token |