Administration
API Keys
API Access lets you create API keys and OAuth clients for programmatic access to your data through the Public Data API.
Quick Start
- 1
Click Create API Key
Found under the API Keys tab of API Access.
- 2
Name the key
Use a name that identifies what the key is for, e.g. the integration or service consuming it.
- 3
Select scopes
Grant only the permissions the key actually needs — each scope is opt-in and unchecked by default.
- 4
Restrict model access (optional)
Leave empty to allow access to all models, or select specific ones to limit the key's reach.
- 5
Create the key
Copy the key immediately — treat it like a password and never commit it to source control.
Available scopes
Read DataRead approved records only.Read All DataRead all records, including pending and rejected.Export DataExport data to CSV, JSON, or Excel.List ModelsView available digitization models.View SchemasAccess model field definitions.Trigger WorkflowsTrigger workflow pipeline runs and read run status.BI MetadataRead the BI service document, $metadata, and dataset list.BI ReadRead published BI dataset rows (Power BI / OData).BI Read AllRead BI dataset rows, including internal-only datasets.Model access
Beyond scopes, you can restrict a key to specific digitization models under Model Access. This is useful when a key is meant for a single integration that should only ever touch one model's data — leave it empty to allow all models.
- Read Data and Read All Data are separate scopes — grant Read All Data only when a key genuinely needs to see pending or rejected records.
- API Access also has an OAuth Clients tab for app-level integrations, separate from individual API keys.
- Click API Documentation in the top right of API Access for the full endpoint reference.