Scope

Project Restriction

The “Project” field allows you to restrict the API key's scope to a specific project:

  • Any — the key has access to all projects in the account

  • Specific project — the key works only with data from the selected project

When making requests using a key linked to a project, the system automatically filters all data to that project only. Requests for data from other projects will be rejected at the API controller level

Scope restriction

The scope determines which API methods are available for use by the key. This is a required field with multiple-choice options.

If you attempt to call a method that is not within the key’s scope, the request will be rejected

Combining restrictions

Project and scope restrictions work together. For example, if a key is restricted to working only with accounts and is linked to a specific project, then:

  • Only methods for working with accounts are available

  • Data is filtered only by the specified project

  • Requests for payments or statistics will be rejected

  • Requests for data from other projects will be rejected

Last updated