Get Groups

Brief Description

• Retrieves the list of groups.

Request Method

• post

Request URL

• {API_ADDRESS}/group/get_groups

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	Used for global trace tracking, suggested to use a unique timestamp per request
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameters Example

{
    "groupName": "Test",
    "groupID": "464588223",
    "pagination": {
        "pageNumber": 1,
        "showNumber": 200
    }
}

Field Name	Optional	Type	Description
groupID	Optional	string	Group ID
groupName	Optional	string	Group Name
pagination	Required	object	Pagination parameter structure
pagination.pageNumber	Required	int	Current page number, starting from 1
pagination.showNumber	Required	int	Number of items requested per page

Success Response Example

{
    "errCode": 0,
    "errMsg": "",
    "errDlt": "",
    "data": {
        "total": 1,
        "groups": [
            {
                "groupInfo": {
                    "groupID": "464588223",
                    "groupName": "Test Group Project",
                    "notification": "",
                    "introduction": "This is test group",
                    "faceURL": "",
                    "ownerUserID": "019825",
                    "createTime": 1741355328901,
                    "memberCount": 24,
                    "ex": "",
                    "status": 0,
                    "creatorUserID": "019825",
                    "groupType": 2,
                    "needVerification": 0,
                    "lookMemberInfo": 0,
                    "applyMemberFriend": 0,
                    "notificationUpdateTime": 0,
                    "notificationUserID": ""
                },
                "groupOwnerUserName": "",
                "groupOwnerUserID": "019825"
            }
        ]
    }
}

Success Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code; 0 indicates success.
errMsg	string	Brief error message, empty if none.
errDlt	errDlt	Detailed error information, empty if none.
data	object	General data object, see structure below
total	int	Total number of groups
groups	array	List of groups
groups.groupInfo	object	Group Information
groups.groupOwnerUserName	string	Owner Name of group
groups.groupOwnerUserID	string	Owner ID of group

Failure Response Example

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Failure Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, refer to global error code documentation
errMsg	string	Brief error message
errDlt	errDlt	Detailed error information