List groups

GET

/groups

List groups under an account.

Prerequisite: Pro or higher account.
Scopes: group:read:admin

Rate Limit Label: Medium

响应示例

200 - response

{
    "groups": [
        {
            "id": "hFK_GtF_e_TaVA808",
            "name": "ipsum",
            "total_members": 10
        },
        {
            "id": "TaVA8QKik_123",
            "name": "awesomegroup",
            "total_members": 0
        }
    ],
    "total_records": 2
}

请求参数

无

返回响应

🟢200**HTTP Status Code:** `200`<br> List of groups returned.<br> **Error Code:** `200` Only available for paid accounts.

application/json

Body

List of Groups.

groups

array [object {3}]

可选

List of Group objects.

id

string

Group ID.

可选

name

string

可选

Group name.

total_members

integer

可选

Total number of members in this group.

total_records

integer

可选

Total records.

🟠404**HTTP Status Code:** `404`<br> **Error Code:** `4130`<br> A group with this {groupId} does not exist.

修改于 2024-04-24 09:06:48

Update a message