List visits
Beta
Lists the visits whose stay overlaps a window of at most 31 days, read in each visit's own local dates, in every status. The order is stable while you follow nextCursor but otherwise unspecified and may change; sort by date or startsAt on your side. Each visitor is one visit: a group visit lists one visit per visitor. A visit with no end, or with an end at or before its start, counts as a one-day stay on its start date. Visits your retention setting deleted no longer appear. Moving a calendar meeting to another calendar cancels its visit and creates a new one with a new id. Visits from before 2026-10-27: no-shows were inferred later, and cancelled ones are missing. Re-read a recent window to see changes.
AuthorizationBearer <pult_<base62>>An API key created by an admin of your organization in the Pult dashboard, sent as Authorization: Bearer <key>. Keys start with pult_.
startDate*stringThe window's first day, inclusive (YYYY-MM-DD).
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$dateendDate*stringThe window's last day, inclusive (YYYY-MM-DD); the window spans at most 31 days, both ends counted.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$dateofficeId?stringOnly visits at this office of your organization.
hostId?array<>Repeatable. Only visits hosted by these users.
1 <= items <= 50status?array<>Repeatable. Only visits in these statuses.
1 <= items <= 50cursor?stringOpaque cursor from pagination.nextCursor of the previous page; omit it for the first page.
1 <= lengthlimit?integerPage size, 1 to 500; default 100.
1 <= value <= 500100OK
application/json- response
data*array<>pagination*Cursor pagination: nextCursor is null on the last page.
meta*curl -X GET 'https://api.pult.com/v1beta/visits?startDate=2019-08-24&endDate=2019-08-24' \ -H 'Authorization: Bearer pult_<key>'{ "data": [ { "id": "string", "status": "requested", "date": "2019-08-24", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "expectedArrivalAt": "2019-08-24T14:15:22Z", "checkedInAt": "2019-08-24T14:15:22Z", "checkedOutAt": "2019-08-24T14:15:22Z", "timeZone": "string", "office": { "id": "string", "name": "string" }, "host": { "id": "string", "email": "string", "firstName": "string", "lastName": "string" }, "visitor": { "firstName": "string", "lastName": "string", "company": "string", "email": "string", "phone": "string" }, "visitorType": { "name": "string" }, "answers": [ { "question": { "text": "string", "type": "free_text" }, "value": "string" } ] } ], "pagination": { "nextCursor": "string" }, "meta": { "startDate": "2019-08-24", "endDate": "2019-08-24" }}