Get credit allocation and balance

GET /v1/advertisers/credits

Gets an advertiser's total and remaining bonus sponsored job credits.

OAuth scope	Access token type
`employer.advertising.account.read`	Employer access token.

Request

Responses

Success

application/json

Schema
Example (from schema)
Example

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
next: The next page of entries in a paginated result.
prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data

object

allocatedBonusSJCredits number

Total bonus sponsored job credits allocated to date.

Includes all credits from inception. New credits added monthly per agreement terms.

remainingBonusSJCredits number

Remaining bonus sponsored job credits available for bonus credit campaigns.

currency string

Credit currency code, such as USD.

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "allocatedBonusSJCredits": 10000,
    "remainingBonusSJCredits": 7500.5,
    "currency": "USD"
  }
}

{
  "data": {
    "allocatedBonusSJCredits": 10000,
    "remainingBonusSJCredits": 7500.5,
    "currency": "USD"
  },
  "meta": {
    "status": 200,
    "rootLocation": "https://apis.indeed.com/ads",
    "links": [
      {
        "rel": "up",
        "href": "/v1/account"
      }
    ]
  }
}

Request did not include a valid access token:

The @@PH0@@ header is missing or malformed. Include the access token using the Bearer scheme — for example, Authorization: Bearer XYZ.
The access token is malformed. When building requests manually, check that you copied the token without missing or extra characters at the start or end.
The access token has expired. Tokens expire after one hour (3,600 seconds).
Get a new token using your client credentials (2-legged OAuth) or a refresh token (3-legged OAuth).

application/json

Schema
Example (from schema)
Example

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
next: The next page of entries in a paginated result.
prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "<p>Invalid OAuth access token.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Valid access token that cannot be used with this API.

Inspect the error returned in meta.errors for details.

Error type Meaning and common causes

INSUFFICIENT_SCOPE The access token does not have the OAuth v2 token scope required for this API endpoint. For common causes, see FAQ and troubleshooting.

Error type	Meaning and common causes
`INSUFFICIENT_SCOPE`	The access token does not have the OAuth v2 token scope required for this API endpoint. For common causes, see FAQ and troubleshooting.
`NOT_EMPLOYER_ACCESS_TOKEN`	This endpoint requires an Employer access token. That is, you must specify the `employer` parameter when requesting the access token. You need to do this for the majority of the Sponsored Jobs API endpoints.
`LEGACY_ACCESS_TOKEN_NOT_ALLOWED`	Sponsored Jobs API no longer supports access tokens that you get through legacy OAuth endpoints. For updated endpoints, see Integrate with Indeed and call APIs.

NOT_EMPLOYER_ACCESS_TOKEN

This endpoint requires an Employer access token.

That is, you must specify the employer parameter when requesting the access token. You need to do this for the majority of the Sponsored Jobs API endpoints.

LEGACY_ACCESS_TOKEN_NOT_ALLOWED

Sponsored Jobs API no longer supports access tokens that you get through legacy OAuth endpoints.

For updated endpoints, see Integrate with Indeed and call APIs.

application/json

Schema
Example (from schema)
Example

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
next: The next page of entries in a paginated result.
prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 403,
    "errors": [
      {
        "type": "INSUFFICIENT_SCOPE",
        "description": "<p>Access token does not have permission to access this API.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

This employer has no bonus sponsored job credits.

application/json

Schema
Example (from schema)
Example

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
next: The next page of entries in a paginated result.
prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 404,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "<p>This employer has no bonus sponsored job credits.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/account"
      }
    ]
  },
  "data": null
}

Unexpected error occurred.

The problem is sometimes temporary and the exact same request may succeed after retrying.

If retrying the request does not help, a problem with parsing the request might have occurred.

Verify that all the required parameters are present and that all parameters are correctly formatted.

If you use an access token obtained with client credentials grant type (2-legged OAuth) with the legacy Sponsored Jobs API endpoint, the INTERNAL_SERVER_ERROR error occurs.

Be sure to use the latest base URL (

https://apis.indeed.com/ads

application/json

Schema
Example (from schema)
Example

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
next: The next page of entries in a paginated result.
prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "<p>Failed to process the request.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Get credit allocation and balance

Request​

Responses​

Schema

Schema

Schema

Schema

Schema

Was this page helpful?

Request

Responses