Query Channel Users

Retrieves a paginated list of users associated with a specific channel. <br> Supports filtering by membership status, roles, and search criteria. <br> Results can be sorted using various options and searched by different user attributes. <br>

GET /api/v4/channels/{channelId}/users

Query Channel Users

cURL

curl --request GET \
  --url https://apix.us.amity.co/api/v4/channels/{channelId}/users \
  --header 'Authorization: Bearer <token>'

200

{
  "channels": [
    {
      "channelId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "channelInternalId": "<string>",
      "channelPublicId": "<string>",
      "isDistinct": true,
      "metadata": {},
      "tags": [
        "<string>"
      ],
      "isMuted": true,
      "isRateLimited": true,
      "muteTimeout": "2023-11-07T05:31:56Z",
      "rateLimit": 123,
      "rateLimitWindow": 123,
      "rateLimitTimeout": "2023-11-07T05:31:56Z",
      "displayName": "<string>",
      "messageAutoDeleteEnabled": true,
      "autoDeleteMessageByFlagLimit": 123,
      "memberCount": 123,
      "messageCount": 123,
      "lastActivity": "2023-11-07T05:31:56Z",
      "avatarFileId": "<string>",
      "isDeleted": false,
      "messagePreviewId": "<string>",
      "isPublic": true,
      "attachedTo": {
        "postId": "<string>",
        "videoStreamId": "<string>",
        "roomId": "<string>"
      }
    }
  ],
  "channelUsers": [
    {
      "userId": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "channelId": "<string>",
      "channelInternalId": "<string>",
      "channelPublicId": "<string>",
      "isBanned": true,
      "lastActivity": "2023-11-07T05:31:56Z",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "readToSegment": 123,
      "lastMentionedSegment": 123,
      "isMuted": true,
      "muteTimeout": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ],
  "paging": {
    "next": "<string>",
    "prev": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

channelId · string · required

Channel ID to query users from

Required string length: 1 - 900

Query Parameters

role · string[]

Role to filter

Required array length: 1 - 20 elements

Required string length: 1 - 900

sortBy · enum<string> · default: lastCreated

Sort channel users by createdAt or updatedAt, default is lastCreated

Available options: lastCreated, firstCreated

memberships · enum<string>[]

Member type to filter - member type: User is member of channel - banned type: User is banned member of channel - muted type: User is member of channel but isMuted is true

Required array length: 1 - 3 elements

Available options: muted, banned, member

options[limit] · integer · default: 10

Number of results per page (1-100)

Required range: 1 <= x <= 100

options[token] · string

Pagination token for getting next/previous pages

Maximum string length: 1000

search · string

Keyword to search for in user information such as displayName, profileHandle, and userId. The search is case-insensitive and supports partial matches.

Maximum string length: 10000

searchBy · enum<string>[]

Fields to search channel users for the keyword (up to 3 fields can be specified)
displayName - search by display name
profileHandle - search by profile handle
userId - search by user id
Default is all three fields

Maximum array length: 3

Available options: displayName, profileHandle, userId

isDeleted · boolean

filter deleted members if isDeleted is null, will return both deleted and non-deleted members

Response

200

application/json

Channels Information

channels · object[]

Show child attributes

channelUsers · object[]

Show child attributes

users · object[]

Show child attributes

files · object[]

Show child attributes

paging · object

Show child attributes