Get all Permissions

Get a list of Permissions.

Note: This endpoint returns an empty list if the roles_and_permissions feature is not enabled for the business. The presence of permissions in the response indicates that the business can use the Business Roles and Staff Permissions endpoints.

Permission Types:

  • Category permissions (2 parts): e.g., payments.manage - Parent permissions that control access to a feature category
  • Extended permissions (3 parts): e.g., payments.invoices.export - Child permissions that require their category permission to be enabled

Available for Staff Tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 10000
Defaults to 1

Page number of results.

number
1 to 100
Defaults to 25

How many items to return per page. Max: 100

string
Defaults to position:desc

Sort by fields. Example: sort=created_at:asc,updated_at:desc

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json