Listar grupos

GET

/groups/

Lista os grupos de clientes cadastrados na empresa autenticada. Retorna até 60 grupos por página, ordenados por nome, excluindo grupos marcados como excluídos (trashed).

Aceita os parâmetros opcionais page (número da página, começando em 1) e text (busca por nome do grupo, case-insensitive).

A resposta traz apenas os dados básicos de cada grupo (id, nome, tipo) — não inclui a lista de clientes vinculados; para isso, use GET /groups/{groupId}/clients.

Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Harvested 200

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/groups/?page=&text=' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "d6c06a8f-2df4-470d-9391-9fee5d139343",
            "name": "teste-documentação",
            "kind": "group"
        }
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Cadastrar grupos

Próxima página

Cadastrar grupo econômico expandido