Docs
API referenceRoll calls

Start a roll call

Preview· P9
POST/roll-calls

Starts a roll call at a site, for example from your fire alarm panel. Agoo takes a snapshot of everyone on site (checked-in visitors and contractors, and clocked-in employees) and, with notify (the default), sends each of them an "I'm safe" link by push, WhatsApp or SMS. Marshals can then account for people in the Workspace app.

  • Fires roll_call.started, then roll_call.updated as people are accounted for.
  • A site can have one active roll call at a time; starting another returns conflict.
  • In test mode, messages go to the console's test outbox.

Scope: rollcalls:write · Plan: Pro and Enterprise in live mode; every plan in test mode.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode

Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

In: header

Scope: rollcalls:write

Header Parameters

Idempotency-Key*string

A UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the original response instead of acting twice. While the first request is still running, a retry returns conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/roll-calls" \  -H "Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64" \  -H "Content-Type: application/json" \  -d '{    "site_id": "site_01kjpt3yw0fz0v414608h9x65s",    "kind": "drill",    "message": "Fire drill. Leave by the nearest exit and go to the car park assembly point.",    "notify": true  }'
{  "id": "rollcall_01m4x13bw0fjmr5ekjkshzkke6",  "site_id": "site_01kjpt3yw0fz0v414608h9x65s",  "kind": "drill",  "status": "active",  "message": "Fire drill. Leave by the nearest exit and go to the car park assembly point.",  "counts": {    "total": 46,    "accounted_for": 0,    "missing": 46  },  "started_at": "2026-10-14T11:00:00Z",  "started_by": null,  "closed_at": null,  "closed_by": null}

List roll calls GET

Returns roll calls, newest first, with their live counts. Use `GET /roll-calls/{rollcall_id}` for the list of people. **Scope:** `rollcalls:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.

Get a roll call GET

Returns one roll call with everyone in its snapshot and whether they are accounted for. Poll it, or listen for `roll_call.updated`, to show a live board. **Scope:** `rollcalls:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.