Yelp Partner Support API
Partner Support operations documented in the Yelp developer reference: Program List All; Business Info; Business Migration Info; Program Info; Program List.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/yelp:yelp-partner-support-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Partner Support API
version: '1.0'
servers:
- url: https://partner-api.yelp.com
security:
- basic: []
tags:
- name: Partner Support
paths:
/programs/v1:
get:
tags:
- Partner Support
summary: Program List All
description: Returns the entire list of past, current and future advertising programs under a given payment account with info for each program (status, start/end date).
operationId: get_program_list_all
parameters:
- name: offset
description: Pagination offset
in: query
required: false
schema:
type: integer
default: 0
- name: limit
description: Pagination limit
in: query
required: false
schema:
type: integer
default: 20
minimum: 1
maximum: 40
- name: program_status
description: Filter by a specific program status
in: query
required: false
schema:
type: string
default: CURRENT
enum:
- PAST
- PAUSED
- CURRENT
- FUTURE
- ALL
responses:
'200':
description: Successfully fetched a list of advertising programs.
content:
application/json:
examples:
Result:
value:
total: 2
program_status: CURRENT
offset: 0
limit: 20
payment_programs:
- program_type: CPC
end_date: '9999-12-31'
program_status: ACTIVE
available_features:
- LINK_TRACKING
- NEGATIVE_KEYWORD_TARGETING
- STRICT_CATEGORY_TARGETING
- AD_SCHEDULING
- CUSTOM_LOCATION_TARGETING
- AD_GOAL
- CALL_TRACKING
program_id: hTF5yeJ8OUQim6AXrz8w
active_features:
- LINK_TRACKING
- AD_GOAL
program_metrics:
currency: USD
ad_cost: 0
billed_clicks: 0
is_autobid: false
billed_impressions: 0
budget: 10000
fee_period: Not Billed
max_bid: 800
program_pause_status: NOT_PAUSED
businesses:
- yelp_business_id: nR5LcSr2yPjpHKc_o2zQ
partner_business_id: null
start_date: '2015-12-10'
- program_type: CPC
end_date: '9999-12-31'
program_status: ACTIVE
available_features:
- LINK_TRACKING
- NEGATIVE_KEYWORD_TARGETING
- STRICT_CATEGORY_TARGETING
program_id: ePVAp5-9zdyw4jvSaccg"
active_features:
- STRICT_CATEGORY_TARGETING
program_metrics:
currency: USD
ad_cost: 0
billed_clicks: 0
is_autobid: false
billed_impressions: 0
budget: 7500
fee_period: Not Billed
max_bid": 1000
businesses:
- yelp_business_id: nR5LcSr2y2wPHKc_o2zQ
partner_business_id: null
start_date: '2015-12-10'
schema:
type: object
properties:
program_status:
type: string
total:
type: integer
offset:
type: integer
limit:
type: integer
payment_programs:
type: array
items:
type: object
properties:
program_type:
type: string
program_id:
type: string
start_date:
type: string
end_date:
type: string
program_status:
type: string
program_pause_status:
type: string
available_features:
type: array
items: type. string
active_features:
type: array
items:
type: string
program_metrics:
type: object
properties:
currency:
type: string
ad_cost:
type: integer
billed_clicks:
type: integer
is_autobid:
type: boolean
billed_impressions:
type: integer
budget:
type: integer
fee_period:
type: string
max_bid:
type: integer
businesses:
type: array
items:
type: object
properties:
yelp_business_id:
type: string
partner_business_id:
type: string
'400':
description: Bad Request.
content:
application/json:
schema:
type: object
properties: []
/v1/business_info/{business_ids}:
get:
summary: Business Info
tags:
- Partner Support
description: Given a list of Yelp business ids, this API returns business information, including business migration information and additional fields such as partner_business_id and cta values for all given businesses.
operationId: get_business_info
parameters:
- name: business_ids
description: Comma-delimited list of yelp business ids (up to 200).
in: path
required: true
schema:
type: string
responses:
'200':
description: Successfully fetched the business infos for the give businesses.
content:
application/json:
examples:
Result:
value:
errors:
- field: vsI-zHdG7QzpGsyxpQnA
id: INTERNAL_SERVER_ERROR
description: Internal Error
businesses:
- city: Westfield
name: Tom's Window Cleaning & Powerwashing
display_url: null
url: http://tomswindowcleaning.net
address1: ''
address2: ''
address3: null
is_migrated: false
longitude: -74.34625
additional_biz_info:
metered_phone: '+19085434296'
category_list:
- Window Washing
- Pressure Washers
cta:
mobile:
description_text: Call Now for a Free Estimate
url: tel:+19085434368
action_text: Call Now
end_date: 0
desktop:
url: http://www.tomswindowcleaning.com/services.html
text: Chandelier Cleaning Experts
button_text: Learn More
end_date: 0
partner_business_id: null
phone: '+19086549430'
state: NJ
postal_code: 07090
is_removed_from_search: false
country: US
latitude: 40.65151
yelp_business_id: NFRthsTNBhfx21R89x1dvw
destination_yelp_business_id: null
is_closed: false
schema:
type: object
properties:
errors:
description: List of errors
type: array
items:
type: array
items:
type: object
properties:
field:
type: string
description: The business id
id:
type: string
description: The error id
description:
type: string
businesses:
type: array
items:
type: object
properties:
city:
type: string
name:
type: string
display_url:
type: string
url:
type: string
address1:
type: string
address2:
type: string
address3:
type: string
is_migrated:
type: boolean
longitude:
type: number
additional_biz_info:
type: object
properties:
metered_phone:
type: string
category_list:
type: array
items:
type: string
category_aliases:
type: array
items:
type: string
cta:
type: object
properties:
mobile:
type: object
properties:
description_text:
type: string
url:
type: string
action_text:
type: string
end_date:
type: string
desktop:
type: object
properties:
url:
type: string
text:
type: string
button_text:
type: string
end_date:
type: string
partner_business_id:
type: string
phone:
type: string
state:
type: string
postal_code:
type: string
is_removed_from_search:
type: boolean
country:
type: string
latitude:
type: number
yelp_business_id:
type: string
destination_yelp_business_id:
type: string
is_closed:
type: boolean
'400':
$ref: '#/paths/~1programs~1v1/get/responses/400'
/v1/business_migration_info/{business_ids}:
get:
summary: Business Migration Info
tags:
- Partner Support
description: Given a list of Yelp business ids, this API provides information about the migration paths of all given businesses.
operationId: get_business_migration_info
parameters:
- name: business_ids
description: Comma-delimited list of yelp business ids (up to 200).
in: path
required: true
schema:
type: string
responses:
'200':
description: Successfully fetched the business migration infos for the given businesses.
content:
application/json:
examples:
Result:
value:
errors:
- field: vsI-zHdG7QzpGsyxpQnA
id: INVALID_BUSINESS_ID
description: Supplied business ID does not exist.
businesses:
- yelp_business_id: NFRthsTNBhfx21R89x1dvw
destination_business_id: null
migration_type: NONE
merged_biz_ids:
- yNH-ZrtGJJbZO97ZfZApcw
- 4mfJ58cpI9Gj5qW1TIvJ3w
schema:
type: object
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/paths/~1v1~1business_info~1{business_ids}/get/responses/200/content/application~1json/schema/properties/errors/items'
businesses:
type: object
properties:
yelp_business_id:
type: string
destination_business_id:
type: string
migration_type:
type: string
merged_biz_ids:
type: array
items:
type: string
required:
- errors
- businesses
'400':
$ref: '#/paths/~1programs~1v1/get/responses/400'
/v1/programs/info/{program_ids}:
get:
summary: Program Info
tags:
- Partner Support
description: Given a list of Yelp program ids, this API returns detailed information about the advertising programs.
operationId: get_program_info
parameters:
- name: program_ids
description: Comma-delimited list of program ids (up to 200).
in: path
required: true
schema:
type: string
responses:
'200':
description: Successfully fetched the advertising program information.
content:
application/json:
examples:
Result:
value:
errors:
- field: 4U9kSBLuBDU391x6bxU-YA
id: INVALID_PROGRAM_ID
description: Supplied program ID does not exist.
programs:
- program_type: CPC
partner_business_id: null
end_date: '2019-02-20'
program_status: ACTIVE
available_features:
- LINK_TRACKING
- NEGATIVE_KEYWORD_TARGETING
- STRICT_CATEGORY_TARGETING
- AD_SCHEDULING
- CUSTOM_LOCATION_TARGETING
- AD_GOAL
- CALL_TRACKING
program_id: obnUPacQSk63k8exSHQ
program_pause_status: NOT_PAUSED
active_features:
- LINK_TRACKING
- AD_GOAL
program_metrics:
currency: USD
ad_cost: 0
billed_clicks: 0
is_autobid: true
billed_impressions: 0
budget: 4000
fee_period: Calendar Month
max_bid: null
future_budget_changes: []
yelp_business_id: vsI-z7cFQzpGsyxpQnA
start_date: '2019-02-19'
has_promo: true
schema:
type: object
properties:
errors:
description: List of errors
type: array
items:
type: array
items:
type: object
properties:
field:
type: string
description: The program id
id:
type: string
description: The error id
description:
type: string
programs:
description: List of programs
type: array
items:
type: object
properties:
program_type:
type: string
partner_business_id:
type: string
end_date:
type: string
format: date
program_status:
type: string
available_features:
type: array
items:
type: string
program_id:
type: string
program_pause_status:
type: string
active_features:
type: array
items:
type: string
program_metrics:
type: object
properties:
currency:
type: string
ad_cost:
type: integer
billed_clicks:
type: integer
is_autobid:
type: boolean
billed_impressions:
type: integer
budget:
type: integer
fee_period:
type: string
max_bid:
type: integer
future_budget_changes:
type: array
yelp_business_id:
type: string
start_date:
type: string
format: date
has_promo:
type: boolean
required:
- errors
- programs
'400':
$ref: '#/paths/~1programs~1v1/get/responses/400'
/v1/programs/list/{business_ids}:
get:
summary: Program List
tags:
- Partner Support
description: Given a list of business ids, this API returns the list of past, current and future advertising programs with info for each program (status, start/end date) for every business id.
operationId: get_program_list
parameters:
- name: business_ids
description: Comma-delimited list of yelp business ids (up to 200).
in: path
required: true
schema:
type: string
- name: start
description: Pagination offset for programs within each business.
in: query
required: false
schema:
type: integer
default: 0
minimum: 0
- name: limit
description: Pagination limit for programs within each business.
in: query
required: false
schema:
type: integer
default: 20
minimum: 0
maximum: 40
responses:
'200':
description: Successfully fetched the advertising program information for the given businesses.
content:
application/json:
examples:
Result:
value:
errors: []
businesses:
- yelp_business_id: vsI-zHdG7QzpGsyxpQnA
destination_yelp_business_id: null
advertiser_status: ADVERTISER
partner_business_id: null
programs:
- program_type: CPC
end_date: '2019-02-20'
program_status: ACTIVE
available_features:
- LINK_TRACKING
- NEGATIVE_KEYWORD_TARGETING
- STRICT_CATEGORY_TARGETING
- AD_SCHEDULING
- CUSTOM_LOCATION_TARGETING
- AD_GOAL
- CALL_TRACKING
program_id: obnUPacQSk63k8exSHQ
active_features:
- LINK_TRACKING
- AD_GOAL
program_metrics:
currency: USD
ad_cost: 0
billed_clicks: 0
is_autobid: true
billed_impressions: 0
budget: 4000
fee_period: Calendar Month
max_bid: null
program_pause_status: NOT_PAUSED
future_budget_changes: []
start_date: '2019-02-19'
has_promo: true
schema:
type: object
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/paths/~1v1~1business_info~1{business_ids}/get/responses/200/content/application~1json/schema/properties/errors/items'
businesses:
type: array
items:
type: object
properties:
yelp_business_id:
type: string
destination_yelp_business_id:
type: string
advertiser_status:
type: string
partner_business_id:
type: string
programs:
type: array
items:
$ref: '#/paths/~1v1~1programs~1info~1{program_ids}/get/responses/200/content/application~1json/schema/properties/programs/items'
required:
- errors
- businesses
'400':
$ref: '#/paths/~1programs~1v1/get/responses/400'
components:
securitySchemes:
basic:
type: http
scheme: basic
x-provenance:
method: searched
source: https://docs.developer.yelp.com/reference
harvested: '2026-11-05'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.developer.yelp.com/reference/get_business_info.md
- https://docs.developer.yelp.com/reference/get_business_migration_info.md
- https://docs.developer.yelp.com/reference/get_program_info.md
- https://docs.developer.yelp.com/reference/get_program_list.md
- https://docs.developer.yelp.com/reference/get_program_list_all.md
merge:
pages: 5
deduped: 11
conflicts_kept_first: 0