Business API
Retrieve a list of team members
api
get
/team-members

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 and the EEA.

This feature is not available in Sandbox.

To use the Team Members API, please contact Revolut API Support.

For more information, see: Tutorials: Manage team members.

Access Token

Each Business API request must contain an authorization header in the following format to make a call: Bearer <your_access_token>.

The access token will be obtained the first time you set up your application and has an expiration of 40 minutes. During setup, a refresh_token will also be obtained which allows to obtain a new access_token.

danger

Never share your client-assertion JWT (JSON web token), access_token and refresh_token with anyone, as these can be used to access your banking data and initiate transactions.

Access tokens can be issued with four security scopes and require a JWT (JSON Web Token) signature to be obtained:

  • READ: Permissions for GET operations.

  • WRITE: Permissions to update counterparties, webhooks, and issue payment drafts.

  • PAY: Permissions to initiate or cancel transactions and currency exchanges.

  • READ_SENSITIVE_CARD_DATA: Permissions to retrieve sensitive card details.

    caution

    If you enable the READ_SENSITIVE_CARD_DATA scope for your access token, you must set up IP whitelisting. Failing to do so will prevent you from accessing any Business API endpoint.

    IP whitelisting means that you must specify an IP or a set of IPs which will be the only IPs from which requests to the API will be accepted. To do so:

    1. In the Revolut Business app, select the corresponding API certificate.
    2. In Production IP whitelist, provide the IP(s) which should be whitelisted, and save.

To configure your JWT and obtain the refresh and first access tokens, complete the following steps:

  1. Sign up for a Revolut Business account
  2. Prepare your Sandbox environment
  3. Make your first API request

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

The ID of the team member.

The email of the team member.

The team member's first name.

The team meber'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.

Was this page helpful?
Loading...