Waitlist API Endpoint Documentation for Developers using Waitlist API

This is an unauthenticated API, meaning that there is no authentication required. All objects returned are publicly viewable and do not expose sensitive data.

GET/api/v1/waitlist?waitlist_id=<waitlist_id>

Get Waitlist

This endpoint returns everything that you need in order to render your Waitlist and create Signups on your front-end.

Query String Attributes

  • Name
    id
    Type
    integer
    Description

    The ID of your waitlist. This can be found on your dashboard.

Response

The response is a Waitlist object.

Request

GET
/api/v1/waitlist?waitlist_id=<waitlist_id>
curl --request GET \
    --url https://api.getwaitlist.com/api/v1/waitlist?waitlist_id=1234

Waitlist Response Example

  "id": 213,
  "configuration_style_json": {
    "social_links": {
      "facebook": "",
      "instagram": "",
      "linkedin": "",
      "pinterest": "",
      "twitter": "https://twitter.com/WaitlistAPI"
    },
    "status_description": "Thanks for signing up!",
    "status_font_color": "#000000",
    "status_main_color": "#222222",
    "widget_background_color": "#4937E7",
    "widget_button_color": "#000000",
    "widget_font_color": "#000000"
  },
  "logo": null,
  "spots_to_move_upon_referral": 3,
  "uses_firstname_lastname": false,
  "uses_leaderboard": true,
  "uses_signup_verification": false,
  "waitlist_name": "Title",
  "waitlist_url_location": "https://getwaitlist.com",
  "statistics": {
      'total_signups': 2200,
      'current_signups': 2200,
  },
  "title": null,
  "success_title": null,
  "required_contact_detail": "EMAIL",
  "widget_shows_social_links": false,
  "signup_button_title": "Sign Up",
  "hide_counts": false,
  "leaderboard_length": 5,
  "remove_widget_headers": false,
  "questions": [{'question_value': "What is your favorite animal?", 'optional': false, "answer_value": ["Cat", "Dog", "Duck", "Other"]}],
  "twitter_message": "",
  "organization_uuid_fk": "30120c24-0ddc-4f35-9bc6-f5e3c7b09257",
}
GET/api/v1/signup/<ID>/leaderboard

Get Waitlist Leaderboard

This route returns the Leaderboard for a Waitlist, if enabled.

Optional Query String Attributes

  • Name
    total_signups
    Type
    string
    Description

    The total number of Signups you want to return as part of the response. Otherwise, this is set by the Leaderboard length parameter that you can configure on your Waitlist's dashboard. (The default for this is 5.)

Response

The response is a Leaderboard object.

Request

GET
/api/v1/waitlist/<ID>/leaderboard
curl --request GET \
    --url https://api.getwaitlist.com/api/v1/waitlist/1234/leaderboard?total_signups=5

Leaderboard Response Example

{
  'leaderboard': [
    {'amount_referred': 5, 'email': 'b***@g**************', 'first_name': 'Brittany', 'last_name': 'S.', 'phone': '415 *** ****'},
    {'amount_referred': 4, 'email': 'b*****@g**************', 'first_name': 'Bianca', 'last_name': 'G.', 'phone': '234 *** ****'},
    {'amount_referred': 1, 'email': 'b*****@g**************', 'first_name': 'Bonnie', 'last_name': 'L.', 'phone': '123 *** ****'},
    {'amount_referred': 1, 'email': 'b*****@g**************', 'first_name': 'Brian', 'last_name': 'N.', 'phone': '117 *** ****'},
    {'amount_referred': 0, 'email': 'b*****@g**************', 'first_name': 'Breanna', 'last_name': 'K.', 'phone': '324 *** ****'},
  ]
}