Team / Team Members /

List team members

Gets a list of members belonging to a team.

Required permission

Account > Admin > Members > Read

Path parameters

teamId
string required
ID of the team

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

members
[array] required
An array of team members.

{object}
A team member object.

id
string required
Internal ID (username) of the team member.
pattern
^[A-Za-z0-9-]+$
username
string
Username of the member.
name
string
Display name from the member profile.
emails
[array]
Email addresses of the member.

string

joinedAt
string
The time the member joined the team.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/teams/{teamId}/members

Example response

200 OK

A list of members in the team.

JSON

{
  "data": {
    "members": [
      {
        "id": "john-doe",
        "username": "john-doe",
        "name": "John Doe",
        "joinedAt": "2021-01-20T11:19:53.175Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}