Skip to main content

Overview

Searches group members.

Request

Authentication: Add authentication headers to the request. See Authentication

Method: POST

Rate limit: 100 requests/second

Endpoint: https://API domain/jim/groups/members/search

Content-Type: application/json

Request parameters

ParameterData typeRequiredDescription
group_idstringYesGroup ID.
keystringYesKeyword.
offsetstringNoPagination offset.
limitnumberNoItems per page. Default: 100.

Request example

POST /jim/groups/members/search HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
"group_id":"groupid1",
"key":"user"
}

Response example

{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"nickname":"xxx",
"avatar":"xxxxxxx",
"member_type":0
}
],
"offset":"xxxx"
}
}

Response codes

Response codesDescription