get-team-members.md

Get Team Members

HTTP Method	URL	Requires Auth
GET	/api/v1/teams.members	yes

Query Parameters

This endpoint supports the offset and count parameters for#pagination query parameters.

Key	Example Value	Description
teamId* or teamName*	ByehQjC44FwMeiLbX or team1	The team ID or the team name. You must enter either one of these parameters.
name	Example Name	The user's name (search filter).
username	some.username	The username (search filter).
status	["online", "away", "busy"]	The user's status (search filter).

Example Call

{% code overflow="wrap" %}

curl  -H 'X-Auth-Token: _2u_4MzRroRcnqc59GYUY_Kwgr9HgtZ9HCKn-2aIvMJ' \
      -H 'X-User-Id: FL2fZL4ERhwA3gWiS' \
      -H "Content-type: application/json" \
      'http://localhost:3000/api/v1/teams.members?teamName=team1&status[]=online&status=away&status=busy'

{% endcode %}

Example Response

{
  "members": [
    {
      "user": {
        "_id": "FL2fZL4ERhwA3gWiS",
        "username": "some.username",
        "name": "Example Name",
        "status": "online"
      },
      "roles": [
        "owner"
      ],
      "createdBy": {
        "_id": "FL2fZL4ERhwA3gWiS",
        "username": "some.username"
      },
      "createdAt": "2021-04-19T23:09:15.109Z"
    }
  ],
  "total": 3,
  "count": 1,
  "offset": 0,
  "success": true
}