Retrieve team roles

Get the list of roles for your business.

The results are paginated and sorted by the created_at date in reverse chronological order.

note

This feature is available in the UK, US, the EEA, and SG.

This feature is not available in Sandbox.

For more information, see the guides: Manage team members.

Request​

Query Parameters

Query Parameters

Default value: the date-time at which the request is made

Retrieves roles with created_at < created_before. The default value is the current date and time at which you are calling the endpoint.

Provided in ISO 8601 format.

Possible values: >= 1 and <= 1000

Default value: 100

The maximum number of roles returned per page.

To get to the next page, make a new request and use the created_at date of the last role returned in the previous response as the value for created_before.

Response​

Information about roles of the business

Response body

Body array of objects

The ID of the role. This can be a UUID or other default role such as OWNER.

The name of the role.

The date and time the role was created in ISO 8601 format.

The date and time the role was last updated in ISO 8601 format.