Waitlist Status of the business

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 including the object that contains wait estimate of each party size (wait_estimates), the closed reason of the waitlist (closed_reason) and the state of the waitlist (state).

Curl example with OAuth authentication:

    root@test:~# curl -X GET "https://api.yelp.com/v3/businesses/${BUSINESS_ID}/waitlist/status" --header "Authorization: Bearer ${API_TOKEN}" --header "Content-Type: application/json"

Example 200 response:

{
    "business_id": "Yelp business id",
    "state": "ON_MY_WAY",
    "closed_reason": null,
    "wait_estimates": {
        "1-2": {
            "est_wait": 0,
            "min_wait": 0,
            "wait_range": "0",
            "max_wait": 0
        },
        "3-4": {
            "est_wait": 0,
            "min_wait": 0,
            "wait_range": "0",
            "max_wait": 0
        },
        "5-6": {
            "est_wait": 0,
            "min_wait": 0,
            "wait_range": "0",
            "max_wait": 0
        },
        "7+": {
            "est_wait": 0,
            "min_wait": 0,
            "wait_range": "0"
        }
    }
}

Note: In order to use this endpoint, the caller should be an onboarded Yelp Waitlist partner

Language
Credentials
Header
Click Try It! to start a request and see the response here!