---
agentTools:
  projectIndex: https://nexaflow.readme.io/llms.txt
---

# Get Waiter

Query all Waiters belonging to a waitlist that you own.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "This is the documentation for the CMS API",
    "version": "1.0.0",
    "title": "CMS Documentation"
  },
  "tags": [
    {
      "name": "waitlist",
      "description": "Waitlist APIs"
    }
  ],
  "paths": {
    "/waitlist/{id}": {
      "get": {
        "tags": [
          "waitlist"
        ],
        "summary": "Get Waiter",
        "description": "Query all Waiters belonging to a waitlist that you own.",
        "operationId": "getWaiter",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Credential id given by the platform",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "waitlistId",
            "in": "query",
            "description": "The ID of your waitlist",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Number of Waiters to skip. For example, if you send offset=250 then you will skip the first 250 Waiters. Default is 0.",
            "example": 0,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Number of Waiters per page of results. For example, limit=100 will return one page of 100 Waiters. Default is 25.",
            "example": 10,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "referral_token",
            "in": "query",
            "description": "Referral token of the Waiter whose referrals you would like to see listed.",
            "example": "4F0BTBMAB",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "questions_request",
            "in": "query",
            "description": "Include this parameter as questions_request=true if you want the Waiter's answers to your questions included.",
            "schema": {
              "type": "boolean",
              "enum": [
                true,
                false
              ]
            }
          },
          {
            "name": "offboarded_request",
            "in": "query",
            "description": "Include this parameter as offboarded_request=true if you want to get all Waiters who have been offboarded.",
            "schema": {
              "type": "boolean",
              "enum": [
                true,
                false
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  },
                  "example": [
                    {
                      "amount_referred": 0,
                      "created_at": "2022-04-10_18-34-28",
                      "email": "maya@getwaitlist.com",
                      "priority": 4985,
                      "referral_link": "https://getwaitlist.com?ref_id=4F0BTBMAB",
                      "referral_token": "4F0BTBMAB",
                      "referred_by_waiter_token": null,
                      "removed_date": null,
                      "removed_priority": null,
                      "uuid": "c60ff9f2-1a58-4551-87ea-414991184fba",
                      "verified": false,
                      "answers": [
                        {
                          "question_value": "Where did you hear about us?",
                          "optional": false,
                          "answer_value": "Twitter"
                        }
                      ],
                      "phone": null,
                      "first_name": "Maya",
                      "last_name": "Kyler",
                      "metadata": {},
                      "waitlist_id": 1234
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Invalid status value"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "externalDocs": {
    "description": "Find out more about Swagger",
    "url": "http://swagger.io"
  },
  "servers": [
    {
      "url": "https://api.nexaflow.xyz/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 95,
      "2": 49,
      "3": 0,
      "4": 6,
      "5": 159,
      "6": 138,
      "7": 0,
      "8": 30,
      "9": 188,
      "10": 93,
      "11": 185
    }
  }
}
```