Skip to main content

List employer campaigns and statuses

GET 
/v1/campaigns

Lists an employer's campaigns and their statuses. Results might be paginated.

Example: List active campaigns, up to 100 per page:

https://apis.indeed.com/ads/v1/campaigns?status=ACTIVE&perPage=100
OAuth scopeAccess token type
employer.advertising.campaign.read

Employer access token.

Request​

Query Parameters

    perPage integer

    Default value: 30

    Maximum number of campaigns to return.

    The response may include fewer campaigns than requested, even when more results are available.

    Always check whether another page exists.

    The maximum is 500 campaigns per page.

    start string

    Position within a paginated response.

    If more results are available, the response includes the next position.

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Campaign status.

    Pass ACTIVE, DELETED, or PAUSED to filter by status.

    By default, the response includes campaigns in all statuses.

    type string

    Possible values: [SOURCE, HOSTED]

    Job type.

    Use SOURCE for jobs from the web or an XML feed.

    Use HOSTED for jobs posted through the Post a Job page.

    By default, the response includes both types.

    fields string

    Comma-separated list of response fields.

    Valid values: Id, Name, Status, NonSpendingReasons, Type, CurrencyCode, TrackingToken, StartDate, FixedEndDate, TargetEndDate, BudgetOnetimeLimit, BudgetMonthlyLimit, FundingSource, SponsorshipPlan, and DailyAvgBudgetPerJob.

    Default: Id, Name, Status.

    campaignIds string

    Comma-separated list of campaignIds to return.

    Supports up to 50 campaign IDs.

    Only fields is supported.

Responses​

Lists campaigns.

If campaignIds is omitted and no campaigns match, the API returns an empty data.Campaigns array with HTTP status 200.

Results may be paginated.

If more results are available, meta.links includes "rel": "next".

Append the href value to the base URL to get the next page.

The next URL includes only the start parameter.

If you used non-default perPage, status, or type values, add them manually.

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

    Campaigns

    object[]

  • Array [

    • Name string

    Possible values: non-empty and <= 250 characters

    Campaign name. Use it to identify the campaign later. It must be unique within your employer account.

    Id string

    Campaign ID. Automatically generated when the campaign is created.

    Status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Default value: ACTIVE

    Campaign status. PAUSED keeps the campaign inactive until you enable it, or temporarily stops sponsorship.

    NonSpendingReasons

    object[]

    Reasons that prevent the campaign from sponsoring jobs.

  • Array [

    • type string

    Possible values: [BEFORE_START_DATE, AFTER_END_DATE, ACCOUNT_MONTHLY_BUDGET_HIT, MONTHLY_BUDGET_HIT, ONETIME_BUDGET_HIT, JOB_SOURCE_NOT_VERIFIED, BILLING_PENDING, USER_PAUSED_CAMPAIGN, USER_DELETED_CAMPAIGN, TARGET_APPLICATIONS_HIT, OTHER]

    ID for the problem. Supported values:

    • BEFORE_START_DATE: The current date in US Central Time is before the campaign start date.

    • AFTER_END_DATE: The current date in US Central Time is on or after the campaign end date.

    • ACCOUNT_MONTHLY_BUDGET_HIT: The employer account has already spent its monthly budget.

    • MONTHLY_BUDGET_HIT: The campaign has already spent its monthly budget.

    • ONETIME_BUDGET_HIT: The campaign has already spent its total budget.

    • JOB_SOURCE_NOT_VERIFIED: Indeed has not yet verified the job source.

    • BILLING_PENDING: The employer account does not have valid billing information.

    • USER_PAUSED_CAMPAIGN: The campaign was paused as requested.

    • USER_DELETED_CAMPAIGN: The campaign was deleted as requested.

    • TARGET_APPLICATIONS_HIT: The campaign has already reached the requested number of applications.

    • OTHER: Unknown reason.

    description string

    Human-readable description of the problem.

  • ]

    • Type string

    Possible values: [SOURCE, HOSTED]

    Type of job sponsored by the campaign. Either SOURCE for jobs gathered from the web, or sent to Indeed by using an XML feed, or HOSTED for jobs posted through the **Post a Job** page.

    CurrencyCode string

    ISO 4217 currency code of the currency for the campaign's budget.

    TrackingToken string

    Possible values: <= 255 characters

    Click-tracking token added to the job URL for sponsored clicks. Use it to identify clicks from Indeed and the campaign that sponsored them.

    BudgetOnetimeLimit number

    One-time budget limit for the campaign. You cannot set budgetOnetimeLimit and budgetMonthlyLimit at the same time.

    BudgetMonthlyLimit number

    Monthly budget limit for the campaign. You cannot set dailyAvgBudgetPerJob, budgetOnetimeLimit, and budgetMonthlyLimit at the same time.

    StartDate date

    Start date for sponsoring jobs, in ISO 8601 YYYY-MM-DD format. Default: current date.

    The campaign starts at the beginning of that day in US Central Time (US/Central). The date must be the current date in CT or later. For example, if startDate is 2026-01-15, the campaign starts on January 15, 2026 at 12:00 AM CT. If you omit the date or use the current date, the campaign starts immediately.

    After the campaign becomes active and starts spending, you cannot update startDate. To pause a campaign temporarily, set status to PAUSED.

    FixedEndDate date

    Date when the campaign must stop sponsoring jobs, even if budget remains. Use ISO 8601 YYYY-MM-DD format.

    If the campaign uses a one-time budget (budgetOnetimeLimit), specify either fixedEndDate or targetEndDate, but not both.

    If the campaign uses a monthly recurring budget (budgetMonthlyLimit), fixedEndDate is optional. Without it, the campaign continues until you pause or delete it. These are called evergreen campaigns.

    The campaign stops at the start of the specified day in US Central Time (US/Central). fixedEndDate must be at least one day after the current date in CT, or after the campaign startDate if one is set. For example, if fixedEndDate is 2026-06-20, the campaign stops on June 20, 2026 at 12:00 AM CT.

    TargetEndDate date

    Date before when the campaign *should* stop sponsoring jobs, though it may continue sponsoring past the given date if it hasn't spent its whole budget yet. Follows the ISO 8601 format of YYYY-MM-DD.

    A campaign with a one-time budget (budgetOnetimeLimit) always have either a fixedEndDate or a targetEndDate, but not both. A campaign with a monthly recurring budget (budgetMonthlyLimit) cannot have a targetEndDate, only a fixedEndDate or no end date.

    The campaign targets the start of the specified day in US Central Time (CT, US/Central). The target end date is at least one day after the current date in CT, or the startDate of the campaign, if the campaign has one. For example, if the target end date is 2026-06-20, the campaign targets June 20, 2026 at 0:00 AM CT.

    FundingSource string

    Funding source for the campaign:

    • Bonus Sponsored Job Credits: Funded with annual deals bonus credits.

    • Budget: Funded with regular budget.

    SponsorshipPlan string

    Possible values: [PREMIUM, STANDARD, ``]

    Sponsorship tier for average daily budget (ADB) campaigns. Returned only if requested with the fields parameter.

    For campaigns funded by annual deals bonus credits, this field returns STANDARD for standard campaigns, PREMIUM for premium campaigns, or an empty string otherwise.

    DailyAvgBudgetPerJob number

    Daily average budget per job for the campaign. Returned only for campaigns that use the average daily budget (ADB) model. You cannot set dailyAvgBudgetPerJob and budgetMonthlyLimit at the same time.

  • ]

Loading...

Was this page helpful?