api:read is a global alias scope that maps to the Read Only option on the token creation page. It automatically extends to cover new API endpoints as they are added. To grant a token access to specific resources and actions instead, use the Custom Scopes picker.
api:read
Last edited on 6 May 2026
Scope Summary
Perform read operations via the API
Required Scopes
To add a scope to an API token, you must also add its required scopes. For example, to add a non-read scope for a resource type, you must also add the read scope for that resource type.
api:read has no additional required scopes.