Skip to main content

Authorization and Permissions

Permission checks are enforced per endpoint after API key authentication.

Available Permissions

PermissionCovers
members:readList and view members
members:writeCreate and update members
passes:readList and view issued pass instances
passes:issueIssue passes and event tickets
passes:revokeRevoke issued passes
passes:reinstateReinstate revoked passes
passes:update_expiryUpdate or remove pass expiry dates
passes:send_emailSend pass delivery emails
pass_templates:readList and view pass templates

Endpoint Mapping

Endpoint groupRequired permission
GET /members, GET /members/{id}members:read
POST /members, PUT /members/{id}members:write
GET /passes, GET /passes/{id}passes:read
POST /passes/issuepasses:issue
POST /passes/{id}/revokepasses:revoke
POST /passes/{id}/reinstatepasses:reinstate
PUT /passes/{id}/expirypasses:update_expiry
POST /passes/{id}/send-emailpasses:send_email
GET /pass-templates, GET /pass-templates/{id}pass_templates:read
Event ticket issuing endpointspasses:issue

If a key does not include the required permission, the API returns HTTP 403.