Lists company visits

Retrieves a paginated list of the company's visits with their visitors and check-in state, ordered by startTime. Filter by office, by the time window the visit overlaps (startDate, endDate), by status and by free text over the visit name, visitor names, emails and companies and the host. To poll for changes pass updatedAt: the list is then ordered by updatedAt and includes cancelled visits (status cancelled, with cancelledAt), so repeat the newest updatedAt you have seen and de-duplicate by id. A visitor check-in, check-out or correction and a cancellation move the visit's updatedAt. Without updatedAt, cancelled visits are only returned when statuses includes cancelled. Requires the Visitors module.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Visits matching the filters, one page

Bodyapplication/json

Example

{
    "total": 100,
    "limit": 10,
    "offset": 0,
    "data": [
        {
            "id": "b1eebc99-9c0b-4ef8-bb6d-6bb9bd380b01",
            "officeId": "a1eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
            "visitType": {
                "id": "f1eebc99-9c0b-4ef8-bb6d-6bb9bd380f01",
                "name": "Business"
            },
            "name": "Quarterly review",
            "status": "scheduled",
            "anonymized": false,
            "startTime": "2026-06-24T09:00:00.000Z",
            "endTime": "2026-06-24T10:00:00.000Z",
            "host": {
                "id": "d1eebc99-9c0b-4ef8-bb6d-6bb9bd380d01",
                "email": "john.host@deskbird.com",
                "firstName": "John",
                "lastName": "Host"
            },
            "visitors": [
                {
                    "id": "c1eebc99-9c0b-4ef8-bb6d-6bb9bd380c01",
                    "userId": null,
                    "email": "jane.visitor@example.com",
                    "firstName": "Jane",
                    "lastName": "Visitor",
                    "companyName": "Example Ltd",
                    "status": "checkedIn",
                    "checkedInAt": "2026-06-24T09:02:00.000Z",
                    "checkedOutAt": null,
                    "checkedInSource": "webapp",
                    "anonymized": false
                }
            ],
            "completedAt": null,
            "cancelledAt": null,
            "createdAt": "2026-06-01T08:00:00.000Z",
            "updatedAt": "2026-06-24T09:02:00.000Z",
            "createdByUserId": "d1eebc99-9c0b-4ef8-bb6d-6bb9bd380d01"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden