Guest

Retrieve a paginated list of guests

get/api/v1/restaurants/{restaurant_id}/guests

Request

Base URL: https://gotable.app
URL: https://gotable.app/api/v1/restaurants/{restaurant_id}/guests
Auth: HTTP bearer

Path parameters

restaurant_idinteger required

Query parameters

pageinteger

Current page number

per_pageinteger

Number of results per page (max 100)

querystring

Search guests by a combination of query and operators to filter.

List of fields you can filter by:

name: The guest's name.
email: The guest's email.
telephone: The guest's telephone.
last_visit: The date of the guest's last visit.
visits: The number of visits the guest has made.
reservations: The number of reservations the guest has made.

List of comparison functions you can use with these fields:

<= less than or equal to
< less than
>= greater than or equal to
> greater than
!= not_equal_to
=, == equal_to
!:, !~ does not contain
:, ~ contains

For example, "John last_visit>=2026-09-08" to find all guests matching the keyword "John" that last visited on any date equal to or in the future of 2026-09-08.

Response

With a valid API token

Example response

{
  "guests": [
    {
      "id": 98765,
      "restaurant_id": 12345,
      "name": "John Doe",
      "email": "john.doe@example.com",
      "subscribed": true,
      "telephone": "+31612345678",
      "visits": 1,
      "reservations": 1,
      "diets": [
        "halal"
      ],
      "allergies": [
        "soja"
      ],
      "tags": [
        "vip"
      ],
      "links": [
        {
          "url": "https://gotable.app/api/v1/restaurants/12345/guests/98765",
          "rel": "self",
          "method": "GET"
        },
        {
          "url": "https://gotable.app/api/v1/restaurants/12345",
          "rel": "restaurant",
          "method": "GET"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total_pages": 1,
    "total_count": 1,
    "links": [
      {
        "href": "https://gotable.app/api/v1/",
        "method": "GET",
        "rel": "next"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.