List

get

https://app.desk.ly/{locale}/api/v2/guest/list

Get a list of guest entries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns the guests of your account. You get one entry per guest booking and one entry per guest registration.

A guest booking is a guest booked onto a desk, room or other resource.
A guest registration is a guest registered for a location without a booked space.

The type field tells the two apart. Guest registrations are only available through this endpoint, not through the Booking endpoints.

This endpoint is available from v2. It is not available in v1.

Requirements

Your license must include guest management. Otherwise the API returns 400 with the error type license.feature.ly.
Your API key needs the Read permission in the Guests row. You set this when you create or edit the API key.

Path Params

locale

string

required

Defaults to en

The locale to provide translated error messages

Query Params

page[limit]

int32

Defaults to 50

The limit of results returned. Has to be between 1 and 250.

page[offset]

int32

Defaults to 0

The offset (amount) of results to be skipped. Has to be positive.

order[]

array of strings

The order the results are returned. Add ^ as prefix to order descending. Default: ^bookingStartDateTime (newest first). The values floor, room and resource sort guest bookings only.

order[]

startDate

date

Start of a date range, for example 2026-11-01. Use together with endDate. Returns every visit that overlaps the range. Do not combine with date[].

endDate

date

End of a date range, for example 2026-11-30. Use together with startDate. Must not be before startDate.

date[]

array of strings

Filter by the start of the visit, with an operator, for example date[]=>=2026-11-01&date[]=<2026-12-01. Do not combine with startDate or endDate.

date[]

location

string

The Location ID (UUID) to filter for. Add ! as prefix to exclude it.

floor

string

The Floor ID (UUID) to filter for. Add ! as prefix to exclude it. Returns guest bookings only.

room

string

The Room ID (UUID) to filter for. Add ! as prefix to exclude it. Returns guest bookings only.

resource

string

The Resource ID (UUID) to filter for. Add ! as prefix to exclude it. Returns guest bookings only.

guestNumber

string

The guest number to filter for.

status[]

array of strings

The status to filter for. expected = not checked in yet, visit ends today or later. arrived = checked in, not checked out. departed = checked out. not_recorded = visit is in the past, guest never checked in.

status[]

Allowed:

Responses

Requirements

200200

400400

401401