Get details for jobs in campaign

GET 
/v1/campaigns/:campaignId/jobDetails

Gets detailed information about jobs in a campaign.

This method uses offset-based pagination, with up to 500 results per page. For multi-page queries, use the hash value in the response to keep results consistent across requests. If the hash changes between pages, wait one minute and restart the query from offset 0.

Which jobs are included?

The list includes jobs the campaign currently sponsors, or would sponsor if it were active. It does not include jobs that the campaign sponsored in the past.

Included jobs depend on these campaign fields: jobsQuery, jobsTitle, jobsCompany, jobsLocation, jobsToInclude, and jobsLocationRadius.

OAuth scope	Access token type
employer.advertising.campaign.read	Employer access token.

Request

Path Parameters

campaignId stringrequired

Campaign ID.

Query Parameters

start integer

Zero-based offset of the first job to get.

perPage integer

Possible values: <= 500

Default value: 100

Maximum number of jobs on a page. Cannot be greater than 500.

fields string

Indicates which fields to include in the response. Valid value is nonSpendingReasons.

Responses

200

Success

application/json

Schema

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

entries

object[]

Array [

jobKey string

Indeed-generated unique identifier for this job.

refNum string

Employer-provided unique identifying number for this job.

If this job was sent to Indeed by using the [XML job feed format](/sponsored-jobs-api/shared-resources/xml-job-feed-format), which corresponds to the `` element in the feed.

title string

Job title.

location string

Job location.

recommendedDailyBudget

object

nullable

Recommended daily budget per job, without any budgetBoostPercentage increase.

Returns null if no budget target is configured.

amount number

Budget amount in currency.

currency string

ISO 4217 currency code, such as JPY or USD.

appliedDailyBudget

object

nullable

Effective daily budget for this job. Returns null if no budget target is configured.

amount number

Budget amount in currency.

currency string

ISO 4217 currency code, such as JPY or USD.

]

hash number

Hash of the full jobs list. Use it to detect changes while paginating through job details.

Example (from schema)

{
  "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": {
    "entries": [
      {
        "jobKey": "89deb9de58ebe149",
        "refNum": "job1-2022-01-01",
        "title": "Data Scientist",
        "location": "Austin, TX",
        "recommendedDailyBudget": {
          "amount": 1500,
          "currency": "USD"
        },
        "appliedDailyBudget": {
          "amount": 1500,
          "currency": "USD"
        }
      }
    ],
    "hash": 50050063
  }
}

Example

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 100,
    "links": null
  },
  "data": {
    "entries": [
      {
        "jobKey": "b8cb4b4790b65cba",
        "refNum": "job1-2025-07-01",
        "title": "SoC Power Modeling Engineer",
        "location": "Austin, TX",
        "nonSpendingReasons": [
          "INSUFFICIENT_BUDGET"
        ]
      },
      {
        "jobKey": "b8cb4b4790b65wer",
        "refNum": "job2-2025-07-01",
        "title": "SoC Power Software Engineer",
        "location": "Austin, TX",
        "nonSpendingReasons": [
          "INSUFFICIENT_BUDGET"
        ]
      },
      {
        "jobKey": "b8cb4b4790b65wek",
        "refNum": "job3-2025-07-01",
        "title": "SoC Power Software Engineer",
        "location": "Austin, TX",
        "nonSpendingReasons": []
      }
    ],
    "hash": 2123789906
  }
}

401

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

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

Example (from schema)

{
  "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
}

Example

{
  "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
}

403

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.
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

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

Example (from schema)

{
  "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
}

Example

{
  "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
}

404

Requested campaign either does not exist or belongs to another employer. Be sure to use an access token that represents the employer that owns the requested campaign. See Get an employer access token.

application/json

Schema

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

Example (from schema)

{
  "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
}

Example

{
  "meta": {
    "status": 404,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "<p>Couldn&#x27;t locate the requested resource.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": {
      "rel": "up",
      "href": "/v1/campaigns"
    }
  },
  "data": null
}

500

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

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

Example (from schema)

{
  "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
}

Example

{
  "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
}

Loading...

 

Was this page helpful?