Listar grupos da conta

Sandbox

GET

/v4/api/groups/

Lista os grupos da conta com a quantidade de membros de cada um, paginado (até 100 por página; a resposta traz meta). O id de cada grupo é o groupId usado nos participantes e no relatório de uso.

Requisição

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Sucesso

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/groups/?page=undefined&perPage=undefined&q=undefined'

Response Example

200 - Exemplo 1

{
    "groups": [
        {
            "id": "string",
            "accountId": "string",
            "name": "string",
            "description": "string",
            "membersCount": 0,
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "perPage": 0,
        "totalPages": 0,
        "totalCount": 0
    }
}

Modificado em 2026-09-28 20:20:25

Página anterior

Excluir contato

Próxima página

Listar membros da conta