# Yelp Developers Documentation

> Come build with us using our API to help connect consumers and great local businesses!

## Guides: Getting Started
- [Getting Started](https://docs.developer.yelp.com/docs/getting-started.md)
- [Yelp Partner APIs](https://docs.developer.yelp.com/docs/yelp-partner-apis.md)

## Guides: Authentication
- [Overview](https://docs.developer.yelp.com/docs/overview.md)
- [Yelp Places Authentication](https://docs.developer.yelp.com/docs/places-authentication.md)
- [OAuth Authorization](https://docs.developer.yelp.com/docs/oauth-authorization.md)
  - [Authorization Code Workflow](https://docs.developer.yelp.com/docs/authorization-code-workflow.md)
  - [Refresh tokens](https://docs.developer.yelp.com/docs/refresh-tokens.md)
- [Basic HTTP Authentication (partner-api.yelp.com)](https://docs.developer.yelp.com/docs/partner-apiyelpcom-basic-http-authentication.md)

## Guides: Yelp Places API
- [Getting Started with the Yelp Places API](https://docs.developer.yelp.com/docs/places-intro.md)
- [Yelp Places API Plan Details](https://docs.developer.yelp.com/docs/plans.md)
- [Rate Limiting](https://docs.developer.yelp.com/docs/places-rate-limiting.md)
- [Additional Resources](https://docs.developer.yelp.com/docs/places-additional-resources.md)
- [Frequently Asked Questions](https://docs.developer.yelp.com/docs/places-faq.md)
- [Business Matching Guidance](https://docs.developer.yelp.com/docs/business-matching-guidance.md)

## Guides: Yelp AI API
- [Getting Started with Yelp AI API](https://docs.developer.yelp.com/docs/yelp-ai-api.md)
- [Building an AI Agent for Local Search with Yelp AI API](https://docs.developer.yelp.com/docs/agentic_ai_api.md): A developer’s guide to creating an intelligent LLM-powered local business search agent using Yelp AI API.
- [Integration Recipes](https://docs.developer.yelp.com/docs/basic-usage.md)
- [Current Capabilities & Limitations](https://docs.developer.yelp.com/docs/current-capabilities-limitations.md)
- [Request-a-Quote](https://docs.developer.yelp.com/docs/request-a-quote-runbook.md)

## Guides: Yelp Insights
- [Yelp Insights Technical Overview](https://docs.developer.yelp.com/docs/yelp-insights.md)
- [Respond to Reviews API](https://docs.developer.yelp.com/docs/respond-to-reviews-api-v2.md)
  - [R2R Integration Guide](https://docs.developer.yelp.com/docs/r2r-integration-guide.md)
  - [Reviews Webhooks](https://docs.developer.yelp.com/docs/reviews-webhooks-v2.md)
  - [Policies](https://docs.developer.yelp.com/docs/policies.md)
  - [FAQs](https://docs.developer.yelp.com/docs/faqs.md): Please note that this information is only relevant for official Yelp partners that are integrated to our Respond to Reviews API. Here's a list of common questions and answers related to our Respond…
- [Partner Feeds](https://docs.developer.yelp.com/docs/partner-feeds.md)
- [Location Subscription API](https://docs.developer.yelp.com/docs/location-subscription-api-v2.md)
  - [Location Subscription API v1 (deprecated)](https://docs.developer.yelp.com/docs/location-subscription-api.md)
- [Private Reviews API](https://docs.developer.yelp.com/docs/private-reviews-api.md)
- [Engagement Metrics API](https://docs.developer.yelp.com/docs/engagement-metrics-api.md)
- [Yelp Insights + Listings Management Guide](https://docs.developer.yelp.com/docs/yelp-insights-listings-management-guide.md)

## Guides: GraphQL
- [Getting Started with Yelp GraphQL](https://docs.developer.yelp.com/docs/graphql-intro.md)
- [Basic Usage](https://docs.developer.yelp.com/docs/graphql-basic-usage.md)
- [Making Requests](https://docs.developer.yelp.com/docs/graphql-making-requests.md)
- [Rate Limiting](https://docs.developer.yelp.com/docs/graphql-rate-limiting.md): GraphQL API Points-Based Daily Limit
- [Localization](https://docs.developer.yelp.com/docs/graphql-localization.md)

## Guides: Additional Resources
- [Supported Locales](https://docs.developer.yelp.com/docs/resources-supported-locales.md)
- [State (Country Subdivision) Codes](https://docs.developer.yelp.com/docs/resources-state-codes.md)
- [Categories](https://docs.developer.yelp.com/docs/resources-categories.md)
- [Event Categories](https://docs.developer.yelp.com/docs/resources-event-categories.md)

## Guides: Webhooks
- [Guide to Webhooks](https://docs.developer.yelp.com/docs/webhooks.md)
- [Webhook Signature Verification](https://docs.developer.yelp.com/docs/webhook-signature-verification.md)

## Guides: Advertising APIs
- [Data Ingestion API](https://docs.developer.yelp.com/docs/data-ingestion-api.md)
  - [Yelp Data Quality Guidelines](https://docs.developer.yelp.com/docs/yelp-data-quality-guidelines.md)
  - [Listing Management Subscription API](https://docs.developer.yelp.com/docs/listing-management-api.md)
  - [SMB Claiming API](https://docs.developer.yelp.com/docs/claiming.md)
  - [Claiming FAQs](https://docs.developer.yelp.com/docs/claiming-faq.md)
  - [Call to Action Best Practices](https://docs.developer.yelp.com/docs/ads-api-call-to-action-best-practices.md)
  - [Data Ingestion FAQs](https://docs.developer.yelp.com/docs/data-ingestion-faqs.md): Here's a list of common questions and answers related to our Data Ingestion APIs. Feel free to leave comments/questions if you have a topic that's not covered here already.
- [Data Ingestion API Testing Guidelines](https://docs.developer.yelp.com/docs/api-testing-guidelines.md)
  - [FAQs](https://docs.developer.yelp.com/docs/faq.md)
- [Ads API](https://docs.developer.yelp.com/docs/ads-api.md)
  - [Ads API Onboarding Guide](https://docs.developer.yelp.com/docs/getting-started-with-the-ads-api.md)
  - [Campaign Management Behavior & Nuances](https://docs.developer.yelp.com/docs/campaign-management-behavior-nuances.md)
  - [Async Job Processing & Error Handling](https://docs.developer.yelp.com/docs/async-job-processing-error-handling.md)
  - [Program Features Reference](https://docs.developer.yelp.com/docs/program-features-reference.md)
  - [Budget & Billing Reference](https://docs.developer.yelp.com/docs/budget-billing-reference.md)
  - [Enhanced Profiles & CTAs](https://docs.developer.yelp.com/docs/enhanced-profiles-ctas.md)
  - [Reporting & Metrics Reference](https://docs.developer.yelp.com/docs/reporting-metrics-reference.md)
  - [FAQs](https://docs.developer.yelp.com/docs/ads-faqs.md): Here's a list of common questions and answers related to our advertising APIs. Feel free to leave comments/questions if you have a topic that's not covered here already.
  - [Documentation Disclaimer](https://docs.developer.yelp.com/docs/documentation-disclaimer.md)
- [Program Feature API](https://docs.developer.yelp.com/docs/program-feature-api.md)
- [Reporting API](https://docs.developer.yelp.com/docs/reporting-api.md)
  - [Reporting v2 to v3 Migration Guide](https://docs.developer.yelp.com/docs/reporting-v2-to-v3-migration-guide.md)
  - [Reporting API v2 (deprecated)](https://docs.developer.yelp.com/docs/reporting-api-v2-deprecated.md)
  - [Reporting v1 to v2 Changelog](https://docs.developer.yelp.com/docs/reporting-v1-to-v2-changelog.md)
  - [Reporting API Terms of Use](https://docs.developer.yelp.com/docs/reporting-api-terms-of-use.md)
- [Partner Support API](https://docs.developer.yelp.com/docs/partner-support-api.md)
- [Verified License Status Webhooks](https://docs.developer.yelp.com/docs/verified-license-status-webhooks.md)
- [Leads API](https://docs.developer.yelp.com/docs/leads-api.md)
  - [Partner Integration Guide](https://docs.developer.yelp.com/docs/partner-integration-guide.md): End-to-end integration guide for the Yelp Leads API, covering authentication, webhooks, messaging flows, and testing.
  - [Leads API - Zapier Integration](https://docs.developer.yelp.com/docs/leads-api-zapier-integration.md): A step by step guide for a no/low code integration with Yelp Leads using Zapier.
    - [Leads Zapier Integration - Access Error When Testing](https://docs.developer.yelp.com/docs/leads-zapier-integration-access-error-when-testing.md): A description of a common error when testing your new Zapier integration with test lead data, as well as a workaround solution.
  - [Leads Webhooks](https://docs.developer.yelp.com/docs/leads-webhooks.md)
  - [Leads API FAQs](https://docs.developer.yelp.com/docs/leads-api-faqs.md): Here's a list of common questions and answers related to our Leads APIs. Feel free to leave comments/questions if you have a topic that's not covered here already.
  - [Phone Number Management API](https://docs.developer.yelp.com/docs/leads-api-copy-1.md)
  - [Lead Interaction](https://docs.developer.yelp.com/docs/lead-interaction.md): Detailed guide on how to manage communication for your Yelp Leads
    - [Migration Guide: Leads API Unmasked Phone Numbers](https://docs.developer.yelp.com/docs/migration-guide-unmasked-phone-numbers.md): Effective April 16, 2026
  - [Yelp Leads Program Agreement](https://docs.developer.yelp.com/docs/yelp-leads-agreement.md)
  - [Backfilling Leads with Time-Based Filtering](https://docs.developer.yelp.com/docs/backfilling-leads-with-time-based-filtering.md)
- [Yelp API Lead Acquisition Terms of Service](https://docs.developer.yelp.com/docs/yelp-api-lead-acquisition-terms-of-service.md)

## Guides: Conversions API
- [Conversions API](https://docs.developer.yelp.com/docs/conversions-api.md)
- [Conversions API - Zapier](https://docs.developer.yelp.com/docs/conversions-api-zapier.md): A step by step guide for a no/low code integration with the Yelp Conversions API using Zapier.

## Guides: Platform APIs
- [Overview](https://docs.developer.yelp.com/docs/yelp-platform.md)
- [Checkout API](https://docs.developer.yelp.com/docs/checkout-api.md)
  - [Resources](https://docs.developer.yelp.com/docs/resources.md)
  - [Notifications](https://docs.developer.yelp.com/docs/notifications.md)
  - [API Errors](https://docs.developer.yelp.com/docs/api-errors.md)
- [Fulfillment API](https://docs.developer.yelp.com/docs/fulfillment-api.md): This specifies the API that Partners must implement on their servers to provide real-time fulfillment availability checks for their services - for example, for checking if a restaurant delivers to a…
  - [Resources](https://docs.developer.yelp.com/docs/fulfillment-resources.md)
- [Iframe Interactions](https://docs.developer.yelp.com/docs/iframe-interactions.md)
  - [API Specification](https://docs.developer.yelp.com/docs/iframe-api-specification.md)
  - [Iframe Style & Developer Guidelines](https://docs.developer.yelp.com/docs/iframe-style-developer-guidelines.md)
- [Order Confirmation](https://docs.developer.yelp.com/docs/order-confirmation.md)

## Guides: Reservation API
- [Yelp Reservations API](https://docs.developer.yelp.com/docs/reservation.md)
- [FAQ](https://docs.developer.yelp.com/docs/faq-1.md)
- [Endpoints (deprecated)](https://docs.developer.yelp.com/docs/endpoints-4.md): This documentation is now deprecated, please head to the API reference section - Reservations API.

## Guides: Business Subscriptions API
- [Business Subscriptions API](https://docs.developer.yelp.com/docs/business-subscriptions-api.md)
- [Changelog and Migration Guide](https://docs.developer.yelp.com/docs/business-subscriptions-migration-guide.md)
  - [Webhook Subscriptions](https://docs.developer.yelp.com/docs/webhook-subscriptions-migration-guide.md): This Migration Guide shows all the necessary steps to migrate from the Webhook Subscriptions API to the Business Subscriptions API.
  - [Listing Management](https://docs.developer.yelp.com/docs/listing-management-migration-guide.md): This Migration Guide shows all the necessary steps to migrate from the Listing Management API to the Business Subscriptions API.
  - [Location Subscriptions](https://docs.developer.yelp.com/docs/location-subscriptions.md): This Migration Guide shows all the necessary steps to migrate from the Location Subscriptions API to the Business Subscriptions API.

## Guides: WAITLIST PARTNER API
- [Overview](https://docs.developer.yelp.com/docs/overview-1.md)

## Guides: Home Services API
- [Home Services API](https://docs.developer.yelp.com/docs/home-services-api.md)

## API Reference: Businesses
- Businesses
  - [Yelp AI API (Search & Chat)](https://docs.developer.yelp.com/reference/v2_ai_chat.md): The Yelp AI API endpoint brings conversational intelligence to your applications, enabling users to ask natural language questions and receive real-time, contextually relevant answers powered by…
  - [Search](https://docs.developer.yelp.com/reference/v3_business_search.md): This endpoint returns up to 240 businesses with some basic information based on the provided search criteria.  Explore our new <a href="https://docs.developer.yelp.com/reference/v2_ai_chat"…
  - [Phone Search](https://docs.developer.yelp.com/reference/v3_business_phone_search.md): This endpoint returns a list of businesses based on the provided phone number. It is possible for more than one business to have the same phone number (for example, chain stores with the same +1 800…
  - [Business Match](https://docs.developer.yelp.com/reference/v3_business_match.md): This endpoint lets you match business data from other sources against businesses on Yelp, based on provided business information. For example, if you know a business's exact address and name, and you…
  - [Business Details](https://docs.developer.yelp.com/reference/v3_business_info.md): This endpoint returns detailed business content. Normally, you would get the Business ID from [/v3/businesses/search](https://docs.developer.yelp.com/reference/v3_business_search),…
  - [Food Delivery Search](https://docs.developer.yelp.com/reference/v3_transaction_search.md): This endpoint returns a list of businesses which support requested transaction type.  **Note:** * At this time, the API does not return businesses without any reviews. * Currently, this endpoint only…
  - [Engagement Metrics](https://docs.developer.yelp.com/reference/v3_get_businesses_engagement.md): Returns engagement metrics information for the provided businesses. <blockquote class="callout callout_warn">   This endpoint requires special permissions to be enabled for your Yelp Places API Key.…
  - [Service Offerings](https://docs.developer.yelp.com/reference/v3_business_service_offerings.md): <blockquote class="callout callout_error">   <strong>Deprecated:</strong> This endpoint has been deprecated in favor of Jobs offered which can be enabled on the Business Details endpoint. Please…
  - [Enable/Disable Request a Phone Call](https://docs.developer.yelp.com/reference/v3_business_rapc_enabledness.md): This endpoint lets you enable or disable Request a Phone Call for a particular business. Check whether the business is eligible using the [Get business by…
  - [Business Insights](https://docs.developer.yelp.com/reference/v3_businesses_insights.md): Returns Business Insights information for the provided businesses. This endpoint is part of Yelp Insights API, visit <a href="https://business.yelp.com/data/products/fusion-insights/"…
  - [Food & Drinks Insights](https://docs.developer.yelp.com/reference/v3_get_business_food_and_drinks_insights.md): This endpoint returns the list of food & drinks offered at the business, including what is trending and the raw food ingredients needed. This endpoint is part of Yelp Insights API, visit <a…
  - [Risk Signal Insights](https://docs.developer.yelp.com/reference/v3_get_business_risk_signals_insights.md): Returns risk signal insights for the provided businesses. This endpoint is part of Yelp Insights API, visit <a href="https://business.yelp.com/data/products/fusion-insights/" target="_blank">Yelp…

## API Reference: Reviews
- Reviews
  - [Reviews](https://docs.developer.yelp.com/reference/v3_business_reviews.md): This endpoint returns up to three review excerpts for a given business ordered by <a href="https://www.yelp-support.com/article/How-is-the-order-of-reviews-determined?" target="_blank">Yelp's default…
  - [Review Highlights](https://docs.developer.yelp.com/reference/v3_business_review_highlights.md): Return a business's review highlights

## API Reference: Events
- Events
  - [Event Search](https://docs.developer.yelp.com/reference/v3_events_search.md): Returns events that match search criteria
  - [Event Details](https://docs.developer.yelp.com/reference/v3_event.md): This endpoint returns the detailed information of a Yelp event. You can get the event ID from <a href="https://docs.developer.yelp.com/reference/v3_events_search" target="_blank">/events</a> or <a…
  - [Featured Event](https://docs.developer.yelp.com/reference/v3_featured_event.md): This endpoint returns the featured event for a given location. Featured events are chosen by Yelp's community managers.

## API Reference: Categories
- Categories
  - [All Categories](https://docs.developer.yelp.com/reference/v3_all_categories.md): This endpoint returns all Yelp business categories across all locales by default. Include the "locale" parameter to filter to only those categories available for a particular locale, and…
  - [Category Details](https://docs.developer.yelp.com/reference/v3_categories.md): This endpoint returns detailed information about the Yelp category specified by a Yelp category alias. The alias for each category can be found either by using the <a…

## API Reference: Home Services
- Home Services
  - [Get Jobs](https://docs.developer.yelp.com/reference/v3_get_jobs.md): This endpoint identifies the most relevant job types based on the end user's home service needs. By providing details about what the user is looking for, this endpoint returns multiple matching job…
  - [Get Survey](https://docs.developer.yelp.com/reference/v3_job_survey.md): This endpoint returns a tailored set of questions and required information based on the provided job alias. This information must be collected from the end user in order to create a project…
  - [Request a Quote](https://docs.developer.yelp.com/reference/v3_raq_submit_project.md): This endpoint allows users to request quotes from home service professionals for their specific needs. After submitting the project details and user contact information, a project is created and a…

## API Reference: Miscellaneous
- Miscellaneous
  - [Autocomplete](https://docs.developer.yelp.com/reference/v3_autocomplete.md): This endpoint returns autocomplete suggestions for search keywords, businesses, and categories based on the input text.

## API Reference: OAuth Authorization v2
- OAuth Authorization v2
  - [Get Access Token v2](https://docs.developer.yelp.com/reference/oauth2_token.md): Either:   1) Exchanges an authorization_code for an access_token, or   2) Exchanges a refresh_token for an access_token. See [Refresh Tokens](https://docs.developer.yelp.com/docs/refresh-tokens) for…
  - [Revoke Access Token](https://docs.developer.yelp.com/reference/oauth2_revoke.md): Revoke a given token.
  - [Get Businesses Associated with Access Token](https://docs.developer.yelp.com/reference/get-businesses-associated-with-an-access-token.md)
- OAuth Authorization v3
  - [Get Access Token v3](https://docs.developer.yelp.com/reference/oauth2_token_v3.md): Either:   1) Exchanges an authorization_code for an access_token, or   2) Exchanges a refresh_token for an access_token. When exchanging a refresh_token for an access_token, also invalidates existing…

## API Reference: Data Ingestion
- Data Ingestion
  - [Business Update](https://docs.developer.yelp.com/reference/create_business_update_v1.md): The Yelp Data Ingestion API provides a means for partners to programmatically perform updates on a large number of businesses asynchronously. Partners can perform updates on various attributes. The…
  - [Job Status](https://docs.developer.yelp.com/reference/get_business_update_status_v1.md): Obtain the status of a Data Ingestion job and its individual parts.

## API Reference: Claim Business
- Claim Business
  - [Claim Business](https://docs.developer.yelp.com/reference/claim_business_v1.md): SMB Claiming API provides a means to submit a business claim and to revoke a business claim on Yelp.
  - [Claim Status](https://docs.developer.yelp.com/reference/get_partner_biz_claim_status_v1.md): Obtain the claim status. You must first the [Job Status Endpoint](https://docs.developer.yelp.com/reference/get_business_update_status_v1) to see if the initial claim request succeeded.

## API Reference: Listing Management
- Listing Management
  - [Retrieve subscriptions](https://docs.developer.yelp.com/reference/get_listing_management_subscriptions_v1.md): This endpoint returns a paginated list of active business subscriptions for Listing Management.
  - [Add subscriptions](https://docs.developer.yelp.com/reference/add_listing_management_subscriptions_v1.md): This endpoint creates new business subscriptions for Listing Management.
  - [Delete subscriptions](https://docs.developer.yelp.com/reference/remove_listing_management_subscriptions_v1.md): This endpoint deletes business subscriptions for Listing Management.

## API Reference: Advertising
- Advertising
  - [Create Program](https://docs.developer.yelp.com/reference/create_reseller_program_v1.md): Creates a new program for a Yelp business
  - [Modify Program](https://docs.developer.yelp.com/reference/modify_reseller_program_v1.md): Modifies an existing program for a Yelp business
  - [Terminate Program](https://docs.developer.yelp.com/reference/end_reseller_program_v1.md): Deletes an existing program for a Yelp business
  - [Program Status](https://docs.developer.yelp.com/reference/get_reseller_status_v1.md): Obtain the status of an existing ingestion job
  - [Pause Program](https://docs.developer.yelp.com/reference/pause_reseller_program_v1.md): Pauses a running CPC program. This endpoint requires special configuration, please get in touch if you would like access.
  - [Resume Program](https://docs.developer.yelp.com/reference/resume_reseller_program_v1.md): Resume a paused CPC program. This endpoint requires special configuration, please get in touch if you would like access.

## API Reference: Program Feature
- Program Feature
  - [Retrieve Program Feature](https://docs.developer.yelp.com/reference/retrieve_program_feature.md): Retrieve available and active features for the specified payment program.  This endpoint returns the program features that are available for the specified program. For each available feature type,…
  - [Add Program Feature](https://docs.developer.yelp.com/reference/add_program_feature.md): Set up or update program features for the specified payment program.  This endpoint sets up feature types for the specified program by providing values for the available features in the request body…
  - [Delete Program Feature](https://docs.developer.yelp.com/reference/delete_program_feature.md): Delete certain program features from the specified payment program.  This endpoint allows deleting particular feature types from the specified payment program. The feature types that have to be…
- Portfolio Project
  - [Retrieve Portfolio Project Info](https://docs.developer.yelp.com/reference/retrieve_portfolio_project_info.md): Get information about a portfolio project.
  - [Update Portfolio Project](https://docs.developer.yelp.com/reference/update_portfolio_project.md): Update an existing project portfolio.  | Parameter      | Accepted values                                                                                            |	Note | -------------- |…
  - [Delete Portfolio Project](https://docs.developer.yelp.com/reference/delete_portfolio_project.md): Delete a portfolio project.
  - [Create a portfolio project draft](https://docs.developer.yelp.com/reference/create_portfolio_project_draft.md): Create a new project draft.
- Portfolio Photo
  - [Get Portfolio Photos](https://docs.developer.yelp.com/reference/get_portfolio_photos.md): Get all photos belonging to a portfolio project.
  - [Upload Portfolio Photos](https://docs.developer.yelp.com/reference/upload_portfolio_photos.md): Upload photos to a portfolio project.  ## Notes:  * The first uploaded photo will be the cover photo. * Either provide an existing biz photo ID or a link to the URL * the `is_before_photo` field adds…
  - [Delete Portfolio Photo](https://docs.developer.yelp.com/reference/delete_portfolio_photo.md): Delete a photo from a portfolio project.

## API Reference: Reporting API V2
- Daily Reports
  - [Request Daily Report](https://docs.developer.yelp.com/reference/create_daily_reports_v2.md): Requests a report containing daily business/advertiser metrics for a specified list of businesses over a date range. Daily metrics can be requested up to 89 days ago.
  - [Get Daily Report](https://docs.developer.yelp.com/reference/get_daily_reports_v2.md): Fetches the daily report associated with {report_id}.
- Monthly Reports
  - [Request Monthly Report](https://docs.developer.yelp.com/reference/create_monthly_reports_v2.md): Requests a report containing monthly business/advertiser metrics for a specified list of businesses over a date range. Monthly business metrics can be requested up to 2 months ago.
  - [Get Monthly Report](https://docs.developer.yelp.com/reference/get_monthly_reports_v2.md): Fetches the monthly report associated with {report_id}.

## API Reference: Reporting API V3
- Daily Reports
  - [Request Daily Report](https://docs.developer.yelp.com/reference/create_daily_reports_v3.md): Requests a report containing daily business/advertiser metrics for a specified list of businesses over a date range. The start date can be up to 730 days (2 years) ago, and the date range (end minus…
  - [Get Daily Report](https://docs.developer.yelp.com/reference/get_daily_reports_v3.md): Fetch the daily report associated with {report_id}.
- Monthly Reports
  - [Request Monthly Report](https://docs.developer.yelp.com/reference/create_monthly_reports_v3.md): Requests a report containing monthly business/advertiser metrics for a specified list of businesses over a date range. The start month can be up to 730 days (2 years) ago, and the date range cannot…
  - [Get Monthly Report](https://docs.developer.yelp.com/reference/get_monthly_reports_v3.md): Fetch the monthly report associated with {report_id}.

## API Reference: Partner Support
- Partner Support
  - [Program List All](https://docs.developer.yelp.com/reference/get_program_list_all.md): 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).
  - [Business Info](https://docs.developer.yelp.com/reference/get_business_info.md): 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…
  - [Business Migration Info](https://docs.developer.yelp.com/reference/get_business_migration_info.md): Given a list of Yelp business ids, this API provides information about the migration paths of all given businesses.
  - [Program List](https://docs.developer.yelp.com/reference/get_program_list.md): 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.
  - [Program Info](https://docs.developer.yelp.com/reference/get_program_info.md): Given a list of Yelp program ids, this API returns detailed information about the advertising programs.

## API Reference: Location Subscription v2
- [Add Business IDs](https://docs.developer.yelp.com/reference/add_business_subscriptions_v2.md)
- [Remove Business IDs](https://docs.developer.yelp.com/reference/remove_business_subscriptions_v2.md)
- [Get Quota](https://docs.developer.yelp.com/reference/get_quota_v2.md)
- [Get Subscribed Business List](https://docs.developer.yelp.com/reference/get_business_subscriptions_v2.md)

## API Reference: Respond to Reviews API
- Access Token
  - [Get Access Token](https://docs.developer.yelp.com/reference/redeem_authorization_code_for_access_token.md): Using the authorization code assigned to the business user, this endpoint will send back an access token.
- Respond to Reviews
  - [Respond to Review](https://docs.developer.yelp.com/reference/create_review_response.md): Create a new review response.
  - [Retrieve Business Owner Information](https://docs.developer.yelp.com/reference/retrieve_business_owner_information-1.md): Retrieve information about the business owner associated with the given access token.
  - [Get Businesses](https://docs.developer.yelp.com/reference/get_businesses_associated_with_access_token.md): Get the businesses associated with an access token.  Authenticate this endpoint with the access token for which to fetch businesses for.

## API Reference: Checkout API
- Checkout API
  - [Create Order](https://docs.developer.yelp.com/reference/create_order.md): This creates a Yelp Checkout Order and is to be called after the user builds and submits his/her order on the iframe. This call returns a `yelp_order_id`.  In other words, the iframe POST goes to the…
  - [Update Order](https://docs.developer.yelp.com/reference/update_order.md): Update an existing Yelp Checkout Order by passing a Order object as the Partner wishes it to be.  Fields that cannot be updated: `yelp_order_id`, `service`, `billing_type`, `partner_business_id`,…
  - [Cancel Order](https://docs.developer.yelp.com/reference/cancel_order.md): Cancel a Yelp Checkout Order.  This can be called anytime after an order is created. Any associated credit card auths will be cancelled, and any charges refunded. The order will transition into a…
  - [Get Order Status](https://docs.developer.yelp.com/reference/get_order_status.md): Get the status of a Yelp Checkout Order.  Partner Server is free to poll the status of an order at any time. It will also be provided as part of the `OrderStatusChangeNotification`.  See…
  - [Update Order Status](https://docs.developer.yelp.com/reference/update_order_status.md): **This API is only for specific food partners.**  This allows a status update to an order. This call returns a status code which indicates if the request was successful.  A notification will not be…
  - [Get Opportunity](https://docs.developer.yelp.com/reference/get_opportunity.md): Get info that user provided (e.g. customer address) when they were checking if business can service them (e.g. business delivers to their address or has a reservation time slot).  The…
  - [Get Status Change Notifications](https://docs.developer.yelp.com/reference/get_status_change_notifications.md): Get status change notifications associated with a Yelp Checkout Order, ordered by most recent first.  See…
  - [Get User Fulfillment Info](https://docs.developer.yelp.com/reference/get_user_fulfillment_info.md): Get user-provided information for delivery or fulfillment purposes.  This may only be called after the user submitted their billing or fulfillment info on Yelp's checkout page (i.e. Order status…

## API Reference: Leads
- Leads
  - [Get Lead](https://docs.developer.yelp.com/reference/get-lead.md): Returns details for a given Lead ID.  Example: To fetch the details for a lead with the ID `jPlz8TM628rzyCRPqrtcvm`, send an…
  - [Get Lead Events](https://docs.developer.yelp.com/reference/get-lead-events.md): Returns the latest events belonging to a given Lead ID.  ## Example To fetch the events belonging to a lead with the ID "jPlz8TM628rzyCRPqrtcvm", send an…
  - [Write Event](https://docs.developer.yelp.com/reference/write-lead-event.md): Create an event in an existing lead. An event represents any interaction that the caller wants to do in an existing lead. Currently, only text messages are supported.  *Example*: To write a message…
  - [Mark Lead as replied](https://docs.developer.yelp.com/reference/mark-lead-as-replied.md): Mark an existing lead as replied through a specified reply medium.  *Example*: To mark a lead with the ID "loPSlzp6M628rzyCRPqrv3tC" as replied through phone, send an…
  - [Mark Lead Event as read](https://docs.developer.yelp.com/reference/mark-lead-event-as-read.md): Mark an existing lead event and all events before that as read.  *Example*: To mark all events before and including the event ID "NJJQvyxvpk87NUpsm2y5Yw" as read at "2022-07-21T20:54:42+00:00", in…
  - [Get Lead IDs for a Business](https://docs.developer.yelp.com/reference/get-lead-ids-for-business.md): Returns the lead IDs for a given Business ID.  Example: To fetch the lead IDs for a business with the ID `VXi7gzRqPKp63X0u6fUtbg`, send an…
  - [Get Lead Metrics](https://docs.developer.yelp.com/reference/get-lead-metrics.md): Returns the metrics belonging to a given Lead ID.  ## Example To fetch the metrics belonging to a lead with the ID "jPlz8TM628rzyCRPqrtcvm", send an…

## API Reference: Phone Number Management
- Phone Number Management
  - [Get Phone Numbers](https://docs.developer.yelp.com/reference/get-phone-numbers.md): Returns the configured outbound phone numbers. Includes the client's inbound phone number only when this capability is enabled for the client.  Outbound phone numbers are allowed to call consumer…
  - [Add Phone Numbers](https://docs.developer.yelp.com/reference/add-phone-numbers.md): Add outbound phone numbers and/or set an inbound phone number.  Inbound phone number is only supported when this capability is enabled for the client. When setting up for the first time (no existing…
  - [Remove Phone Numbers](https://docs.developer.yelp.com/reference/remove-phone-numbers.md): Remove outbound phone numbers.  These phone numbers will no longer be allowed to call consumer numbers.  Note: This endpoint is only required for legacy masked phone number leads before 16th April…
  - [Clear Phone Masking Configuration](https://docs.developer.yelp.com/reference/clear-all-phone-numbers.md): Removes all configured phone numbers and clears the phone masking configuration.  Note: This endpoint is only required for legacy masked phone number leads before 16th April 2026

## API Reference: Business Subscriptions
- Business Subscriptions
  - [Get Business Subscriptions](https://docs.developer.yelp.com/reference/get_business_subscriptions.md): Retrieve a paginated list of business subscriptions for a given subscription type.  Example: To fetch the first 100 business subscriptions of type WEBHOOK, sent a GET request to the following URL:…
  - [Subscribe to businesses](https://docs.developer.yelp.com/reference/create_business_subscriptions.md): Create business subscriptions of the given types. Subscriptions are created asynchronously after a request is accepted. There is a maximum number of subscriptions with type YELP_KNOWLEDGE that can be…
  - [Unsubscribe from businesses](https://docs.developer.yelp.com/reference/remove_business_subscriptions.md): Remove business subscriptions of the given types. Subscriptions are removed asynchronously after a request is accepted. There is a maximum number of subscriptions with type YELP_KNOWLEDGE that can be…
  - [Get Quota](https://docs.developer.yelp.com/reference/get_business_subscriptions_quota.md): Get quota information for the given subscription type. This includes the maximum number of subscriptions that can be active this month, the current total number of active subscriptions and the…

## API Reference: Webhooks
- Webhooks
  - [Add Business IDs to Allow List](https://docs.developer.yelp.com/reference/add_businesses_to_allow_list.md): Add business IDs to Allow List.  Example: If you want to add the following two business IDs, send a POST request with the following JSON body:  ```json { 	"business_ids": […
  - [Get Webhook Signing Keys](https://docs.developer.yelp.com/reference/get_webhook_signing_keys.md): Returns the current set of public keys used to sign webhook payloads, in [JSON Web Key Set (JWKS)](https://datatracker.ietf.org/doc/html/rfc7517) format.  Use these keys to verify the…
  - [Remove Business IDs from Allow List](https://docs.developer.yelp.com/reference/remove_businesses_to_allow_list.md): Remove business IDs from Allow List.  Example: If you want to remove the following two business IDs, send a POST request with the following JSON body:  ```json { 	"business_ids": […
  - [Subscribe to Webhooks](https://docs.developer.yelp.com/reference/subscribe_to_webhooks.md): To subscribe to webhooks for all businesses a Biz Owner has access to send an [authenticated](https://docs.developer.yelp.com/docs/authorization-code-workflow) POST request to the…
  - [Unsubscribe to Webhook](https://docs.developer.yelp.com/reference/unsubscribe_to_webhook.md): Unsubscribe from a webhook subscription using the `webhook_id` obtained during the subscription process. Use an [authenticated](https://docs.developer.yelp.com/docs/authorization-code-workflow)…
  - [Linkout Attribution](https://docs.developer.yelp.com/reference/v3_conversion_webhook.md): The linkout attribution endpoint allows you to connect Yelp events, with relevant events of your service.  ## Example If you provide a booking service and are partnered with Yelp, we will send a…

## API Reference: Location Subscription v1
- [Add Business IDs](https://docs.developer.yelp.com/reference/testinput.md)
- [Remove Business IDs](https://docs.developer.yelp.com/reference/remove-business-ids.md)
- [Get Quota](https://docs.developer.yelp.com/reference/get-quota.md)
- [Get Subscribed Business List](https://docs.developer.yelp.com/reference/get-subscribed-business-list.md)

## API Reference: Fulfillment API
- Fulfillment API
  - [Check Availability](https://docs.developer.yelp.com/reference/check_fulfillment_availability.md): Check if the given business can currently fulfill an order.  This call will be made by Yelp to the Partner when the User is on the biz details page and wants to enter the ordering flow. The…

## API Reference: Waitlist Partner API
- Waitlist
  - [Waitlist Status of the business](https://docs.developer.yelp.com/reference/v3_business_waitlist_status-1.md): This endpoint returns waitlist status about a specific business by querying the encryped Yelp business id. All the returned fields that are included in this endpoint are configuration fields…
  - [Waitlist Infomation of the business](https://docs.developer.yelp.com/reference/v3_business_waitlist_info-1.md): This endpoint returns waitlist information about a specific business by querying the encryped Yelp business id. All the returned fields that are included in this endpoint are configuration fields…
  - [Create waitlist on-my-way](https://docs.developer.yelp.com/reference/v3_business_waitlist_on-my-way-1.md): Create a waitlist on-my-way visit in a restaurant.  **Curl example with OAuth authentication:** ```sh     root@test:~# curl -X POST https://api.yelp.com/v3/businesses/{BUSINESS_ID}/waitlist/on-my-way…
  - [Join queue](https://docs.developer.yelp.com/reference/v3_business_waitlist_visits-1.md): Join the queue for a restaurant.  **Note:** Prior to making a call to this endpoint, the restaurant must currently be on a wait, nor the API caller will receive response with 422 `CURRENTLY_NO_WAIT`.…
  - [Cancel a visit](https://docs.developer.yelp.com/reference/v3_visit_cancel-1.md): Cancel an on-my-way or a waitlist visit by the given encrypted visit identifier.  **Curl example with OAuth authentication:** ```sh     root@test:~# curl -X POST…
  - [Get details of a visit](https://docs.developer.yelp.com/reference/v3_visit_get-1.md): Get the visit details by the given encrypted visit identifier.  **Curl example with OAuth authentication:** ```sh     root@test:~# curl -X GET "https://api.yelp.com/v3/visits/{VISIT_ID}" --header…
  - [Partner Restaurants](https://docs.developer.yelp.com/reference/v3_partner_restaurants-1.md): This endpoint returns a list of restaurants that were onboarded with the partner. Both Business ID and Display name will be returned for each onboarded restaurants.  **Curl example with OAuth…

## API Reference: Reservations API
- Bookings
  - [Openings](https://docs.developer.yelp.com/reference/v3_openings.md): To get the available reservation times for a restaurant, you can give this endpoint the Business ID along with a few parameters. This endpoint will return times around the requested timeslot and…
  - [Holds](https://docs.developer.yelp.com/reference/v3_holds.md): This endpoint will place a temporary hold on the requested time slot so that the partner can request all the required reservation information from the user. Holds are only valid for 5 minutes and you…
  - [Reservations](https://docs.developer.yelp.com/reference/v3_reservations.md): With this endpoint, you can place a physical reservation at a restaurant with all the information provided. This endpoint will take an optional hold id if the partner previously placed a hold. If the…
  - [Reservation Status](https://docs.developer.yelp.com/reference/v3_reservation_status.md): To check the status of an existing reservation, you can use this endpoint with the reservation ID. This endpoint will return the current status and details of the reservation.  The response will…
  - [Reservation Cancel](https://docs.developer.yelp.com/reference/v3_reservation_cancel.md): The cancel endpoint allows you to cancel a reservation using a reservation_id.  **cURL example with OAuth authentication:** ```sh     curl -X POST…
  - [Reservation Availability Update](https://docs.developer.yelp.com/reference/reservation_availability_update_v3.md): Push reservation availability data for a venue. Each request contains slot data for one business across one or more dates.  **Key concepts:** - **Per-date full replacement:** Each date you send…

## Pages
- [Places API Plan Details: Attributes & Search Filters](https://docs.developer.yelp.com/page/start-your-free-trial.md)

## Changelog
- [Unmasked Phone Numbers](https://docs.developer.yelp.com/changelog/unmasked-phone-numbers.md)
- [Fusion AI API: Reservation support fields added](https://docs.developer.yelp.com/changelog/fusion-ai-api-reservation-support-fields-added.md)
- [AI-Assisted Reservations](https://docs.developer.yelp.com/changelog/ai-assisted-reservations.md)
- [Fusion AI API enhanced: Smarter conversations & direct business questions](https://docs.developer.yelp.com/changelog/fusion-ai-api-enhancements-smarter-conversations-direct-business-questions.md)
- [Natural Language Search API endpoint deprecated](https://docs.developer.yelp.com/changelog/natural-language-search-api-endpoint-deprecated.md)
- [Fusion AI API released: Next generation search & chat](https://docs.developer.yelp.com/changelog/new-ai-api-chat-endpoint-released.md)
- [New limits for Business Search endpoint](https://docs.developer.yelp.com/changelog/new-limits-for-business-search-endpoint.md)
- [Fusion and GraphQL Daily Rate Limits Changed](https://docs.developer.yelp.com/changelog/fusion-daily-rate-limits-changed.md)
- [Business Subscriptions API published](https://docs.developer.yelp.com/changelog/business-subscriptions-api-published.md)
- [Reporting API v3 published](https://docs.developer.yelp.com/changelog/reporting-api-v3-published.md)