Guides Coming soon

ArrivalsHQ

The ArrivalsHQ endpoints let your own systems do what reception does in the portal: register and sign in visitors, see who is on site, record staff movements, log parcels and follow an evacuation. They are the endpoints the portal uses, so each call has the same effect as doing it on screen. The host is emailed, the visitor appears on the roll call and the dashboard updates.

Setting up sign-in journeys, badges, printers, kiosks, documents and other ArrivalsHQ settings is done in the portal, not through the API.

Scopes

Create a token as described in Authentication, for a user whose role has the scopes your integration needs. Most endpoints accept any one of several scopes, and each endpoint in the reference lists them. These are the usual ones:

To Scope
Read visits, who is on site and who is expected visitors.read
Register, change, cancel, sign in and sign out visitors, and log parcels visitors.manage
Read the staff directory and where people are arrivals.staff.view
Record staff movements arrivals.staff.manage
Mark parcels collected arrivals.deliveries.manage
Read evacuations and roll calls arrivals.emergency.view
Start and end evacuations arrivals.emergency.manage
Sign yourself in and out read

Visitors

A visit can be run end to end through the API. See Visitors for the details.

To Call
Pre-register a visitor POST /visitors
Read one visit GET /visitors/{visitorId}
Update contact details, host, office or times PUT /visitors/{visitorId}
Move an upcoming visit, with its bookings PATCH /visitors/{visitorId}/visit
Cancel an upcoming visit POST /visitors/{visitorId}/cancel
Sign a visitor in now POST /visitors/{visitorId}/sign-in
Sign a visitor out POST /visitors/{visitorId}/check-out
Every visit by the same person GET /visitors/{visitorId}/visits

Who is on site

To Call
List the visitors on site at an office GET /visitors/signed-in
Find a visitor expected today for a host, by name GET /visitors/expected
The visitor log for an office on a date GET /visitors/{officeId}/{date}
The staff directory, with where each person is now GET /staff

GET /visitors/signed-in and GET /visitors/expected need office_id; without it they return an empty list. GET /visitors/expected is a name lookup, not a full list: send the visitor's name and the host's host_id, and it returns up to five close matches, best first, each with a match_score.

Who is on site at one office
GET /api/v1/visitors/signed-in?office_id=5e4d3c2b-1a09-4f8e-a7d6-c5b4a3928170

GET /staff is paged, but its response isn't the standard paginated shape: there is no links object, and meta.on_site counts the people on site or on break. It also returns the statuses you can set, which you need for recording staff movements.

Staff sign-in

There are two ways to record staff movements. A back-office system, such as access control, HR or a rota, records a movement for anyone. A member's own app or device signs that member in and out.

To Call
Set a member's status POST /staff/{userId}/attendance
Sign yourself in at an office POST /users/me/staff-presence/sign-in
Sign yourself out POST /users/me/staff-presence/sign-out

Movements are recorded by setting one of your organisation's statuses, set up under Staff sign-in in the portal. Each status counts as on site, off site or on break, and the evacuation roll call goes by that. GET /staff lists the statuses under statuses.

An access-control system records an arrival
{
  "custom_status_id": "6d1e8b3a-4c2f-4a9e-b7d0-3f5a1c9e2b84",
  "notes": "Main entrance turnstile"
}

Self sign-in checks the position against the office geofence when you send latitude and longitude. Sign-out is never checked, so someone who forgot to sign out can do it later.

Deliveries

To Call
Log a parcel for a member or a named recipient POST /deliveries
Mark a parcel collected POST /deliveries/{deliveryId}/collect

The recipient is emailed when a parcel is logged for them, as they would be from the kiosk. Deliveries are available on ArrivalsHQ plans that include them.

Log a parcel
{
  "courier_name": "DPD",
  "recipient_user_id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
  "package_count": 2,
  "notes": "Fragile"
}

Emergency roll call

A building management or alerting system can start and end an evacuation, and read who is still unaccounted for. Marking people safe stays with fire marshals in the portal and on the marshal page.

To Call
Start an evacuation POST /evacuations
End an evacuation POST /evacuations/{evacuationId}/end
List evacuations in progress, with totals GET /evacuations/active-list
Read an evacuation's roll call GET /evacuations/{evacuationId}

Starting an evacuation has the same effect as an admin starting one in the portal: marshals are alerted and the roll call opens. Send office_id or site_id to limit it; send neither to cover every office.

Roll calls don't include phone numbers or email addresses.

Times and errors

  • Visit times: send expected_arrival in the office's local time, such as 2026-11-03 10:00, because that's the time printed on the invitation. A visit's expected_arrival, time_in and time_out are returned with no time zone, such as 2026-11-03 10:04:12. A few responses differ, for example the sign-out response; the reference notes each one.- 403: the token lacks a scope the endpoint accepts, or the feature isn't on your ArrivalsHQ plan.
  • 409: the visit has already started, so it can't be changed or cancelled (a cancelled visit can't be changed either); or another evacuation already covers the office.
  • 422: validation failed. If a visit's desk, parking space or meeting room can't move with it, the body has code set to booking_clash and lists each clash.

The Conventions guide covers headers, errors and pagination across the whole API.