---
title: "List Team Members"
slug: "list-team-members"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/list-team-members"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# List Team Members

Get/api/v1/teams.members

List all members of a team. Permission required: `view-all-teams`

Header parametersX-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Query parametersteamNamestring

The team name. It is required if the `teamId` is not provided.

Examplelivestream
teamIdstring

The team id. It is required if the `teamName` is not provided.

Example63f3efc4b000b6b6d86704b2
namestring

Search filter for the user's name

Exampletest
usernamestring

Search filter for the user's username

Exampletest.user
statusarray of string

Search filter for the user's status

Example["online", "away", "busy"]

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='2260e924-10b2-4e48-bb17-c40ecb418215'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='fad25d14-9714-4c69-9896-87abc1e11b7a'>Success</option>
</select>Success

```json
{
  "members": [
    {
      "user": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "roxie",
        "name": "test test",
        "status": "offline",
        "settings": {
          "preferences": {
            "themeAppearence": "light"
          },
          "profile": {}
        }
      },
      "roles": [
        "owner"
      ],
      "createdBy": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "test.test"
      },
      "createdAt": "2023-02-20T22:10:12.740Z"
    },
    {
      "user": {
        "_id": "5fRTXMt7DMJbpPJfh",
        "username": "test.test",
        "name": "Testtest",
        "status": "offline",
        "settings": {
          "profile": {}
        }
      },
      "createdBy": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "test.test"
      },
      "createdAt": "2023-07-11T00:23:01.346Z"
    }
  ],
  "total": 2,
  "count": 2,
  "offset": 0,
  "success": true
}
```

Expand Allobject  members Array of object   object  userobject  _idstring    
usernamestring    
namestring    
statusstring    
settingsobject  preferencesobject  themeAppearencestring    

profileobject  

roles Array of string   string    
createdByobject  _idstring    
usernamestring    

createdAtstring    

totalinteger    
countinteger    
offsetinteger    
successboolean    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='2e2e2fc9-06e7-4d58-bac0-50cde8ad2efc'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f250abbd-101d-480b-abee-90438bf9b167'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring