Get Business Subscriptions

get

https://api.yelp.com/v3/businesses/subscriptions

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:
https://api.yelp.com/v3/businesses/subscriptions?subscription_type=WEBHOOK

For the above request a successful GET call will return at most 100 business subscriptions with the following response body:

{
  "total": 2,
  "offset": 0,
  "limit": 100,
  "subscription_type": "WEBHOOK",
  "subscriptions": [
    {"business_id": "4U9kSBLuBDU391x6bxU-YA", "subscribed_at": "2022-12-10T09:50:00+00"},
    {"business_id": "7w8SVwIEhxZ7jPnMUFYrng", "subscribed_at": "2022-12-10T10:52:30+00"},
  ]
}

Note: Each subscription type requires configuration by Yelp to access, please reach out to [email protected] to configure access.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
This endpoint is part of the Business Subscriptions API, visit Business Subscriptions API to learn more.

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
PARTNER_ENDPOINT_DISABLED	You are trying to access a Partner API endpoint for which your API Client has not been enabled. Please reach out to [email protected] for more information.
AUTHORIZATION_ERROR	Authorization Error

📘

200Successfully fetched the business subscriptions

400Bad Request. Message varies depending on failure scenario

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.

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