Skip to main content

List members

Description

Retrieve a list of team members.

Request

HTTP Method: GET

Path ParameterDescription
team-idID of the team
curl -X GET \
https://<tenant-domain>/api/v1/teams/<team-id>/members \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'

Response

A successful request will return a JSON Array describing team members.

Field description

ParameterDescription
idUser ID.
emailUser email.
first_nameUser first name.
last_nameUser last name.
is_adminBoolean flag indicating whether user is an admin.
created_atTimestamp describing when the user was created.
last_seenTimestamp describing when the user was last seen in the platform.
invitation_acceptedBoolean flag indicating if the user accepted the invitation to join the team

Sample response

{
"members": [
{
"id": 1,
"first_name": "First name",
"last_name": "Last name",
"email": "user@example.com",
"is_admin": true,
"created_at": "2021-03-11T09:00:58Z",
"last_seen": "2021-04-30T08:56:05Z",
"invitation_accepted": true
}
],
"meta": {
"current_page": "https://<tenant-domain>/api/v1/teams/4178/members?per_page=20&page=1",
"previous_page": null,
"next_page": null,
"per_page": 20,
"pages": 1,
"count": 1
}
}