Get Lead IDs for a Business

get

https://api.yelp.com/v3/businesses/{business_id}/lead_ids

Returns the lead IDs for a given Business ID.

Example:
To fetch the lead IDs for a business with the ID VXi7gzRqPKp63X0u6fUtbg, send an authenticated GET request to the following URL:
https://api.yelp.com/v3/businesses/VXi7gzRqPKp63X0u6fUtbg/lead_ids

A sample response is shown in the example response box on the right under "200 - Lead IDs"

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

business_id

string

required

The Yelp Business ID

Query Params

limit

integer

1 to 20

Defaults to 20

The maximum number of items to return. Default=20 (1-20).

after_lead_id

string

If specified, only lead IDs that come after this lead ID will be returned.

created_after

string

If specified, only leads created at or after this timestamp (inclusive) will be returned. ISO 8601 format with timezone required, e.g. 2024-06-30T23:59:59Z or 2024-06-30T23:59:59%2B00:00. Can be combined with created_before to define a time range. Time filters are applied first, then results are paginated with after_lead_id within the filtered window.

created_before

string

If specified, only leads created at or before this timestamp (inclusive) will be returned. ISO 8601 format with timezone required, e.g. 2024-06-30T23:59:59Z or 2024-06-30T23:59:59%2B00:00. Can be combined with created_after to define a time range. Time filters are applied first, then results are paginated with after_lead_id within the filtered window.

Responses

code	description
UNAUTHORIZED_API_KEY	The API key provided is not currently able to query this endpoint.
TOKEN_INVALID	Invalid API key or authorization header.

code	description
UNAUTHORIZED_BUSINESS_MINIMUM_ADVERTISING	"You're not authorized to access this business as it does not meet minimum advertising requirements."
NO_BUSINESS_ACCESS	"You don't have access to this Business."

200The lead IDs were fetched successfully.

400The provided ID is not recognized as a valid Yelp Lead ID

401The API key has either expired or doesn't have the required scopes to query this endpoint. codedescriptionUNAUTHORIZED_API_KEYThe API key provided is not currently able to query this endpoint.TOKEN_INVALIDInvalid API key or authorization header.

404The Lead with the given ID was not found.

429You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.

500Internal Server Error