Retrieve a list of team members

Get information about all the team members of 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 team members 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 team members returned per page.

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

Response​

Information about team members of the business

Response body

Body array of objects

The ID of the team member.

The email of the team member.

The team member's first name.

The team member's last name.

Possible values: [created, confirmed, waiting, active, locked, disabled]

The state that the team member is in.

The ID of the team member's role. This can be a UUID or other default role such as Owner.

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

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