Sponsored Jobs API integration guide for bonus-credit campaigns

Sponsor jobs in special campaigns with bonus credits from an Indeed Annual Deal Agreement.

 

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.

Overview

This guide covers API support for using bonus sponsored job credits under an Indeed Annual Deal. Use bonus sponsored job credits to sponsor jobs in designated special campaigns. When credits are allocated to your advertiser account, Indeed creates the corresponding campaigns automatically.

As of 2026-01-19, use the Sponsored Jobs API to view your bonus-credit balance, identify bonus-credit campaigns, monitor per-job budgets, and update job selection queries.

Summary of changes

Sponsored Jobs API summary of changes

Endpoint	Change type	Change description
Get credit allocation and balance GET /v1/advertisers/credits	New	Gets an advertiser's total and remaining bonus sponsored job credits. See: Get credit balance visibility (new) Per-job budget visibility (updated)
List employer campaigns and statuses GET /v1/campaigns	Enhanced	New fields values: FundingSource SponsorshipPlan DailyAvgBudgetPerJob See bonus-credit campaign identification (updated endpoints).
Get general campaign information GET v1/campaigns/{campaignId}	Enhanced	Auto-includes fields: FundingSource SponsorshipPlan See Single campaign details.
Get campaign budget and duration GET /v1/campaigns/{campaignId}/budget	Enhanced	For bonus-credit campaigns, auto-includes field: dailyAvgBudgetPerJob See Per-job budget visibility (updated).
Update general campaign information PATCH v1/campaigns/{campaignId}	Enhanced	For bonus-credit campaigns, added job selection criteria. See Job selection updates.

Credit balance visibility (new)

Get credit allocation and balance

Endpoint	Get credit allocation and balance GET /v1/advertisers/credits
Description	Gets an advertiser's total and remaining bonus sponsored job credits. Credit balance is returned in real time.
Authentication	OAuth 2.0 with employer scope
Response	Current total credits allocated Current remaining credit balance Currency
Use cases	Check available credits before planning campaigns Monitor credit allocation Track credit utilization throughout the month

Bonus-credit campaign identification (updated endpoints)

Enhanced campaign list

List employer campaigns and statuses

Endpoint	List employer campaigns and statuses GET /v1/campaigns
Description	The campaign list endpoint already supports a fields parameter that enables you to specify which data to include in the response. Additional fields query parameter values: FundingSource SponsorshipPlan
Authentication	OAuth 2.0 with employer scope
Request	The fields parameter accepts comma-separated values. To get campaign funding and tier information, include either or both these fields values: FundingSource. Identifies whether bonus credits fund a campaign. SponsorshipPlan. Identifies premium tier campaigns.
Response	FundingSource values: "Bonus Sponsored Job Credits" for bonus-credit campaigns. Empty string ( "") for non-bonus-credit campaigns. SponsorshipPlan values: "Premium" for bonus-credit premium campaigns, including those created through the UI. Empty string ("") for non-bonus-credit campaigns and non-premium campaigns.

Single campaign details

Get general campaign information

Endpoint	Get general campaign information GET /v1/campaigns/{campaignId}
Description	Unlike the enhanced campaign list endpoint, the response from the single campaign details endpoint always includes both the FundingSource and SponsorshipPlan fields.
Authentication	OAuth 2.0 with employer scope
Request	The fields parameter accepts comma-separated values. To get campaign funding and tier information, include either or both these fields values: FundingSource. Identifies whether bonus credits fund a campaign. SponsorshipPlan. Identifies premium tier campaigns.
Response	FundingSource values (always present). Either: "Bonus Sponsored Job Credits" for bonus-credit campaigns. Empty string ( "") for non-bonus-credit campaigns. SponsorshipPlan values (always present). Either: "Premium" for Bonus-credit premium campaigns, including those created through the UI. Empty string ("") for non-bonus-credit campaigns and non-premium campaigns. For null values and empty strings, the JSON response includes both: FundingSource (when empty) SponsorshipPlan (when null or empty)

Integration recommendations

• For list employer campaigns and statuses queries:

  • To filter or display bonus-credit campaigns, always include FundingSource in your fields parameter.
  • To identify bonus-credit premium campaigns, include SponsorshipPlan.
  • For complete classification, include both values.

• For get general campaign information, both fields are always present. No special handling is needed.

  • To identify regular campaigns, check for empty string ("") in FundingSource.
  • To identify standard-tier campaigns, check for empty string ("") in SponsorshipPlan.

• Use cases:

  • Filter and display bonus-credit campaigns separately.
  • Identify bonus-credit premium tier campaigns.

Per-job budget visibility (updated)

• Updated endpoints:

  • GET /v1/campaigns (opt-in through the fields query parameter)
  • GET /v1/campaigns/{campaignId}/budget (automatic)

Bonus-credit campaigns use a daily budget model where Indeed recommends a daily budget for each job. Traditional campaigns use a total budget for the month or campaign duration.

• Current state: Campaign endpoints return BudgetOnetimeLimit (total lifetime budget) or BudgetMonthlyLimit (monthly budget). Only the applicable field appears based on campaign type.

• New: DailyAvgBudgetPerJob field shows the average daily budget per job in bonus-credit campaigns.

  Indeed's optimization system automatically manages per-job budgets based on your job selection. This value is read-only.

Enhanced campaign list

Endpoint	List employer campaigns and statuses GET /v1/campaigns (opt-in through the fields query parameter)
Description	This endpoint already supports a fields query parameter that defines returned data. New: DailyAvgBudgetPerJob field shows the average daily budget per job in bonus-credit campaigns. When the field appears: You include dailyAvgBudgetPerJob in the fields parameter. Campaign is a bonus-credit campaign (or other ADB campaign). Campaign has per-job budget configured. When the field is hidden: Campaign is not an ADB campaign (regular-budget campaign). Field was not requested in the fields parameter. Key behavior: For bonus-credit campaigns: Returns only DailyAvgBudgetPerJob. For regular campaigns: Only BudgetOnetimeLimit or BudgetMonthlyLimit appears (current behavior). Field is conditional. It only appears when relevant and requested.
Authentication	OAuth 2.0 with employer scope
Request	The fields parameter accepts comma-separated values. To get campaign funding and tier information, include either or both these fields values: FundingSource. Identifies whether bonus credits fund a campaign. SponsorshipPlan. Identifies premium tier campaigns.
Response	FundingSource values (always present). Either: "Bonus Sponsored Job Credits" for bonus-credit campaigns. Empty string ("") for non-bonus-credit campaigns. SponsorshipPlan values (always present). Either: "Premium" for Bonus-credit premium campaigns, including those created through the UI. Empty string ("") for non-bonus-credit campaigns and non-premium campaigns. For null values and empty strings, the JSON response includes both: FundingSource (when empty) SponsorshipPlan (when null or empty)

Job selection updates

Job selection updates

Endpoint	Update general campaign information PATCH /v1/campaigns/{campaignId}
Description	Update job selection for bonus-credit campaigns. Allowed updates for bonus-credit campaigns: jobsToInclude (ALL or QUERY-based) jobsQuery
Restrictions	Indeed manages other campaign settings (name, status, objective, budget). You cannot modify these values through the API.
Use cases	Add or remove jobs from bonus-credit campaigns.

Integration workflow

1. Prerequisites

Before integrating, verify that you have:

• Active Annual Agreement with Indeed
• OAuth 2.0 credentials configured with employer scope
• US-based advertiser account (initial release is US-only)
• Credits allocated to your advertiser account (handled by your Indeed Customer Service team)

2. Campaign creation process

info

When Indeed initially allocates bonus credits to your account, we automatically create bonus-credit campaigns on your behalf.

1. Indeed creates the bonus-credit campaign in your account.
2. Campaign becomes immediately visible through the API.

3. Monitor your credit balance

• Call GET /v1/advertisers/{yourAdvertiserId}/credits with the OAuth Bearer token:

  • Before sponsoring jobs in a bonus-credit campaigns.

  • When credits are allocated.

  • Weekly or as needed for spend tracking.

Best practice: Cache the balance and avoid excessive polling (calls count toward rate limits).

4. Identify your bonus-credit campaigns

• Option A: List all campaigns with funding source:

  • To identify which campaigns are bonus-credit funded, call GET /v1/campaigns.

    Include FundingSource in the fields parameter.

  • To identify bonus-credit campaigns versus regular budget campaigns, check whether FundingSource equals "Bonus Sponsored Job Credits".

• Option B: Get details for specific campaign:

  • Call GET /v1/campaigns/{campaignId}.

    This call automatically includes the FundingSource field in the response.

5. Update job selection

• Call PATCH /v1/campaigns/{creditCampaignId} with a JSON body that contains job selection criteria.

  You can update these fields:

  • jobsToInclude. Selection mode ( ALL or QUERY).

  • jobsQuery. Search keywords.

  You cannot update these fields:

  • Campaign name, status, objective, budget (automatically managed), jobsTitle, jobsCompany, jobsLocation, jobsLocationRadius.

  Error handling: Updating restricted fields returns the error:

  "Only Jobs Query Criteria field update is allowed for campaigns using Bonus Sponsored Job Credits."

6. View budget allocation

• Call GET /v1/campaigns. For a specific campaign, call GET /v1/campaigns/{campaignId}/budget.

• With either call, set the fields parameter to include DailyAvgBudgetPerJob and FundingSource.

  The call returns:

  • The total campaign budget allocation.

  • Average daily budget per job (for bonus-credit campaigns).

 

Was this page helpful?