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.
This endpoint is part of the Business Subscriptions API, visit Business Subscriptions API to learn more.