Overview
Lists group join requests, including direct join requests and invitations.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
GET
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/groups/grpapplications
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| group_id | string | Yes | Group ID. | |
| start | int | No | Start timestamp for retrieving the list. For descending order, defaults to the current time; for ascending order, defaults to 0. | |
| count | int | No | Items per page. Default: 20. Maximum: 50. | |
| order | int | No | Retrieval order: 0 for descending; 1 for ascending. Default: 0. |
Request example
GET /jim/groups/grpapplications?group_id=group1&start=1734407505753&count=50 HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
Response example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"apply_type":1, //0:invitation; 1: proactive application;
"sponsor":{ //applicant information for a proactive join request
"user_id":"userid1"
},
"inviter":{ //inviter information for a group invitation
"user_id":"userid2"
},
"recipient":{ //invitee information for a group invitation
"user_id":"userid3"
},
"operator":{ //information about the administrator handling the request
"user_id":"userid4"
},
"status":1, // 0: application pending; 1: application accepted; 2: application rejected; 3: application expired; 10: invitation pending; 11: invitation accepted; 12: invitation rejected; 13: invitation expired;
"apply_time":1734407505000 //request submission time
}
]
}
}