API Reference Overview
This section documents all available API operations and types. It covers both the GraphQL API (queries and mutations) and the REST API (documents, passes, bookings export).
How to read these docs
Section titled “How to read these docs”Operation pages
Section titled “Operation pages”Each GraphQL operation page includes:
- Signature — the full GraphQL signature with arguments and return type
- Arguments table — every argument with type, default value, and description
- Permission — the permission required to call this operation
- Return type — linked to the type definition page
- Example — curl and JavaScript snippets
Type pages
Section titled “Type pages”Each type page includes:
- Fields table — every field with type (linked) and description
- Used by — which operations reference this type, for navigation context
Permissions model
Section titled “Permissions model”Most mutation operations require a specific permission granted to your API token. Permissions are scoped to an organisation — the organisationId argument determines which organisation’s permissions are checked.
See the Permissions Reference for a complete list.