Waiter API

This is the main API to create new submissions to your Waitlist. This is an unauthenticated API, meaning that there is no authentication required. All objects returned are publicly viewable and do not expose sensitive data.


POST/api/v1/waiter

Create a Waiter

This route creates a new Waiter on a Waitlist. The Waiter's email address and the Waitlist API Key are required. A Waiter Object is returned.

If this email address has already been submitted for this Waitlist, then a waiter already exists. In that case, the existing Waiter Object is returned.

This route only returns Unauthenticated Waiter Objects since it is publicly accessible.

Required attributes

  • Name
    email
    Type
    string
    Description

    The email address of this Waiter.

  • Name
    api_key
    Type
    string
    Description

    The API key for the Waitlist that the Waiter is trying to sign up for.

  • Name
    referral_link
    Type
    string
    Description

    A URL including a referral token. This is the current page from which the Waiter is signing up on the waitlist, i.e. document.URL.

Optional attributes

  • Name
    first_name
    Type
    string
    Description

    The first name of the waiter.

  • Name
    last_name
    Type
    string
    Description

    The last name of the waiter.

  • Name
    phone
    Type
    string
    Description

    The phone number of the waiter.

Response

The response is a Waiter object.

Request

POST
/api/v1/waiter
curl --request POST \
  --url https://api.getwaitlist.com/api/v1/waiter \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "example9911@example.com",
    "api_key": "0RN8X1",
    "referral_link": "https://getwaitlist.com/?ref_id=1234"
  }'

Waiter Response

{
  "amount_referred": 0,
  "created_at": "2022-04-10_18-34-28",
  "email": "maya@getwaitlist.com",
  "priority": 4985,
  "referral_link": "https://www.getwaitlist.com?ref_id=4F0BTBMAB",
  "referral_token": "4F0BTBMAB",
  "referred_by_waiter_token": null,
  "removed_date": null,
  "removed_priority": null,
  "total_waiters_currently": 4986,
  "uuid": "c60ff9f2-1a58-4551-87ea-414991184fba",
  "verified": false,
  "waitlist_api_key": "0RN8X1"
}

POST/api/v1/waiter

Create a Waiter with Question Answers

Use this route if you want to create a new Waiter on your waitlist and ask questions as well. When data is submitted, we record their answers alongside their email and referrals. The Waiter's email address and the Waitlist API Key are required. A Waiter Object is returned.

If this email address has already been submitted for this Waitlist, then a waiter already exists. In that case, the existing Waiter Object is returned. If the waiter submits an answer again, we record all answers separately so no data is lost.

This route only returns Unauthenticated Waiter Objects since it is publicly accessible.

Required attributes

  • Name
    email
    Type
    string
    Description

    The email address of this Waiter.

  • Name
    api_key
    Type
    string
    Description

    The API key for the Waitlist that the Waiter is trying to sign up for.

Optional attributes

  • Name
    referral_link
    Type
    string
    Description

    A URL including a referral token. Conventionally, this is the current page from which the Waiter is signing up, i.e. document.URL.

  • Name
    question_1
    Type
    string
    Description

    The question text corresponding to answer_1, as configured in your Waitlist dashboard.

  • Name
    question_2
    Type
    string
    Description

    The question text corresponding to answer_2, as configured in your Waitlist dashboard.

  • Name
    question_3
    Type
    string
    Description

    The question text corresponding to answer_3, as configured in your Waitlist dashboard.

  • Name
    answer_1
    Type
    string
    Description

    The waiter's response to question_1.

  • Name
    answer_2
    Type
    string
    Description

    The waiter's response to question_2.

  • Name
    answer_3
    Type
    string
    Description

    The waiter's response to question_3.

  • Name
    first_name
    Type
    string
    Description

    The first name of the Waiter.

  • Name
    last_name
    Type
    string
    Description

    The last name of the Waiter.

  • Name
    phone
    Type
    string
    Description

    The phone number of the Waiter.

Response

The response is a Waiter object. We store their answers on our backend and it can be exported via a CSV, but we do not expose it in the returned value to ensure that answers are kept privately.

Request

POST
/api/v1/waiter
curl --request POST \
    --url https://api.getwaitlist.com/api/v1/waiter \
    --header 'Content-Type: application/json' \
    --data '{
      "email": "example9911@example.com",
      "api_key": "0RN8X1",
      "referral_link": "https://getwaitlist.com/?ref_id=1234",
      "question_1": "What is your favorite type of food?",
      "question_2": "What city are you in?",
      "question_3": "What musical instrument do you want to learn?"
      "answer_1": "Cornflakes",
      "answer_2": "Philadelphia",
      "answer_3": "Drums"
    }'