List groups a user has joined

Retrieve a paginated list of group channels that a specific user has joined. You can filter by member role and control sort order.

Request

POST: https://[Base URL](/platform-chat-api/base-url)/v4/group-channel/joined/list

Rate limit: 100 per second

Signature: Required. See API request signature.

Request body

Content type: application/json

Parameter	Type	Required	Description
userId	String	Yes	User ID.
role	Number	No	Role filter. 0: All roles (default). 1: Regular member. 2: Admin. 3: Group owner.
pageToken	String	No	Pagination token returned from the previous request. Omit for the first request.
pageSize	Number	No	Number of results per page. Default: 50. Maximum: 100.
order	Number	No	Sort order by join time. 0: Ascending. 1: Descending (default).

Request example

HTTP

POST /v4/group-channel/joined/list HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "userId": "userid1",
    "role": 2,
    "pageToken": "XXX",
    "pageSize": 50,
    "order": 1
}

Response

Field	Type	Description
code	Number	Return code. 0 indicates success. See Status codes.
pageToken	String	Pagination token for the next page. Only present if there are more results.
groups	Array	List of group objects.
groups[i].channelId	String	Group channel ID.
groups[i].name	String	Group name.
groups[i].alias	String	Group alias (remark name) set by the user.
groups[i].groupProfile	JSON	Group basic information.
groups[i].groupExtProfile	JSON	Group extended information.
groups[i].permissions	JSON	Group permission settings.
groups[i].createdAt	Number	Timestamp when the group was created.
groups[i].joinedAt	Number	Timestamp when the user joined the group.
groups[i].role	Number	User's role in the group.
groups[i].memberCount	Number	Number of group members.
groups[i].owner	String	Group owner's user ID.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": 0,
    "result": {
        "pageToken": "XXXX",
        "groups": [
            {
                "channelId": "g123",
                "createdAt": 17096222222,
                "memberCount": 23,
                "role": 1,
                "name": "g1231",
                "joinedAt": 1709619756077,
                "owner": "abc"
            },
            {
                "channelId": "g456",
                "createdAt": 1709611111,
                "memberCount": 231,
                "role": 2,
                "name": "g3333",
                "joinedAt": 1709619756077,
                "owner": "abc"
            }
        ]
    }
}