Scopes

Scopes control what your access token is authorised to do. You can request specific scopes during the token exchange, or omit the scope field to receive all scopes granted to your account.

Available scopes

Scope	Description
partner.read	Read access to partner resources
partner.write	Write access to partner resources
partner.webhooks	Manage webhook subscriptions

Requesting scopes

Pass a space-separated list of scopes in the scope field of your token exchange request:

{
  "grantType": "urn:ietf:params:oauth:grant-type:jwt-bearer",
  "assertion": "...",
  "scope": "partner.read partner.write"
}

Behaviour

• Omitted: All scopes granted to your account are included.
• Valid scopes requested: Only the requested scopes are granted.
• Invalid scopes requested: Unrecognised scopes are silently ignored. If no valid scopes remain, all granted scopes are returned as a fallback.

Least privilege

We recommend requesting only the scopes your application needs. For example, if you only need to read data, request partner.read only:

{
  "scope": "partner.read"
}

This limits the impact if your access token is ever compromised.