How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yelp

Yelp Leads API

Leads operations documented in the Yelp developer reference: Get Lead IDs for a Business; Get Lead; Get Lead Events; Write Event; Mark Lead Event as read; Mark Lead as replied.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yelp Leads API is one of 32 APIs that Yelp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and 5 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.yelp.com/v3/.

6 operations 5 paths 25 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.yelp.com/v3
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Yelp Leads API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Leads 6
GET
/businesses/{business_id}/lead_ids
Get Lead IDs for a Business
get-lead-ids-for-business 5 params → 200400401403404429500
GET
/leads/{ID}
Get Lead
get-lead 1 param → 200400401403404429500
GET
/leads/{ID}/events
Get Lead Events
get-lead-events 4 params → 200400401403404429500
POST
/leads/{ID}/events
Write Event
write-lead-event 1 param body → 201400401403404429500
POST
/leads/{ID}/events/mark_as_read
Mark Lead Event as read
mark-lead-event-as-read 1 param body → 201400401403404429500
POST
/leads/{ID}/mark_as_replied
Mark Lead as replied
mark-lead-as-replied 1 param body → 201400401403404429500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are LeadObject (13 properties), LeadEventBase (7 properties), Project (5 properties), WriteLeadEventRequest (2 properties). Each schema is shown below with its type and property counts.

Error400GetLead
The provided ID is not recognized as a valid Yelp Lead ID
Error400MarkLeadEventAsRead
This error is returned in any of the following scenarios: - The provided lead ID in the URL is not recognized as a valid Yelp Lead ID. - The provided event ID…
MarkLeadEventAsReadRequest
object
The request body of the POST /v3/leads/{leadid}/events/markasread endpoint
2 properties 1 required
Project
object
The project
5 properties 4 required
LeadEventBase
object
A lead event
7 properties 6 required
RequestBodyValidationFailureResponse
object
1 property
MarkLeadAsRepliedRequest
object
The request object of the POST /v3/leads/{leadid}/markasreplied endpoint
1 property 1 required
LeadObject
object
13 properties 4 required
RequiredLeadID
The Yelp Lead ID
ProjectConsumerUser
object
The consumer user that created the project
1 property 1 required
LeadEvent
object
GetEventsResponse
object
1 property 1 required
Error403WriteEvent
This error is returned in any of the following scenarios: - The business user has been blocked from creating an event in the lead. - The business isn't current…
WriteLeadEventRequest
object
The request object of the POST /v3/leads/{leadid}/events endpoint
2 properties 2 required
LeadEventContentBase
object
1 property 1 required
RequiredBusinessID
The Yelp Business ID
LeadEventTextMessage
object
A lead event representing a text message
Error404
The Lead with the given ID was not found.
Error400MarkLeadAsReplied
This error is returned in any of the following scenarios: - The provided ID in the URL is not recognized as a valid Yelp Lead ID. - The replytype parameter is…
Error403MarkLeadAsReplied
This error is returned in any of the following scenarios: - The business user has been blocked from marking a lead as replied - The business user has already m…
LeadEventOther
object
A lead event representing an other message. Other might be any other event type that is not available as a structured response through this API, such as struct…
Error400WriteEvent
This error is returned in any of the following scenarios: - The provided ID in the URL is not recognized as a valid Yelp Lead ID. - The same successive message…
Error403Read
This error is returned in any of the following scenarios: - The business isn't currently advertising. - The business user doesn't have access to the business.…
LeadEventAttachments
object
A lead event representing one or multiple attachments. Any attachment may also have a corresponding event with the same ID and the eventtype TEXT.
Error404MarkLeadEventAsRead
This error is returned in any of the following scenarios: - The Lead with the given ID was not found - The specified event ID does not exist - The event ID whi…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yelp-leads-api-openapi.yml Raw ↑

Other APIs Yelp publishes across the network.

Yelp AI API
AE Profile APIs.io
Yelp Businesses API
AE Profile APIs.io
Yelp Categories API
AE Profile APIs.io
Yelp Events API
AE Profile APIs.io
Yelp Reviews API
AE Profile APIs.io
Yelp Advertising API
AE Profile APIs.io
Yelp Business Subscriptions API
AE Profile APIs.io
Yelp Claim Business API
AE Profile APIs.io
Yelp Data Ingestion API
AE Profile APIs.io
Yelp Home Services API
AE Profile APIs.io
Yelp Listing Management API
AE Profile APIs.io
Yelp OAuth Authorization v2 API
AE Profile APIs.io
← Back to Y APIs
API Details
ID
yelp:yelp-leads-api
Base URL
https://api.yelp.com/v3
Docs
https://docs.developer.yelp.com/reference/get-lead-events
Provider
Yelp
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yelp-leads-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yelp-leads-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Yelp Leads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.