Skip to main content
API scopes define the permissions your application has when accessing Pleo APIs. Scopes determine which resources your application can read or modify. Your application cannot access APIs or perform actions outside the scopes granted to it. You request scopes when registering your application as part of Pleo’s Technology Partner Early Access Programme and during the authorisation process.

​
Scope format

Scopes use a resource and permission format: resource:permission Examples:
  • export-jobs:write
  • export-jobs:read
  • users:read

​
Available scopes by API

Each API defines its own set of scopes:

​
When scopes are evaluated

Scopes are enforced when your application makes API requests. If your access token does not include the required scope, the API will reject the request.

​
Important

Ensure you request all scopes required for your integration. Missing scopes will prevent your application from accessing the corresponding API endpoints.