Scopes limit what an authenticated key can do. Start with the operations your integration actually performs, then grant their required scopes. Broad permissions are easier to set up but harder to review when an integration changes owners.
Read and manage permissions
| Scope | Purpose |
|---|---|
templates:read |
List and retrieve templates |
templates:manage |
Create, draft, publish, archive and restore templates |
waivers:read |
Search records and retrieve details, PDFs and captured photos |
waivers:write |
Submit or void records, clear flags and set tags |
participants:read |
Search participants and retrieve their linked records |
events:read |
List events and retrieve an event |
events:manage |
Create and update events and manage invitations |
messages:send |
Send confirmations and authorize invitation delivery |
checkins:read |
Search candidates and list arrivals |
checkins:write |
Record an arrival |
webhooks:manage |
Manage endpoints, deliveries, secrets and replay |
prefill:write |
Create and retrieve prefill links |
Check operations with more than one scope
Sending or resending event invitations requires event-management permission and messages:send. Creating an event without sending invitations is a different permission decision. A booking integration that only prepares prefilled signing links does not automatically need permission to submit waivers.
The endpoint reference displays the required scopes beside each operation. Treat that list as the final check for the request you are implementing. Scope names are not a substitute for reviewing what the endpoint changes.
Plan a permission review
Write down the integration owner, the server using the key and the operations it needs. For a reporting service, verify whether it really needs participant details or only waiver summaries. For an arrival terminal, separate candidate search from the action that records a new check-in.
Test missing permissions deliberately in your development setup. A 403 should produce an actionable configuration error for your operator, not an endless retry loop. Never fall back automatically to a more powerful production key.
Revisit the list when you add a feature. A service that starts as a report and later sends guest messages has acquired a new responsibility. Keep its documented purpose aligned with its actual access. See authentication and credential rotation for the surrounding lifecycle.