Grupos de Empresas

Buscar grupos de empresas do cliente (paginado) para seleção.

GET · API de Integração v2

GET/v2/grupos-empresas/opcoes

Retorna itens { id, nome } paginados, para escolher o grupoEmpresasId usado em Complementos no POST /v2/pessoas.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de consulta3

pageinteger

Página (1-based)

padrão: 1
perPageinteger

Itens por página (default 15, máx 100)

qstring

Texto de busca (título do grupo)

Respostas1

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece
A operação foi concluída.
Como tratar
Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · */*

Exemplo · HTTP 200
{
  "content": [
    {
      "id": 10,
      "nome": "Grupo Exemplo"
    }
  ],
  "page": 1,
  "perPage": 1,
  "total": 1,
  "totalPages": 1
}

Contrato de respostas

200OK

OK

*/*

contentGrupoEmpresasResponse[]
Ver propriedades
idinteger

ID do grupo de empresas

formato: int64exemplo: 10
nomestring

Nome do grupo de empresas

exemplo: Grupo Exemplo
pageinteger
formato: int32
perPageinteger
formato: int32
totalinteger
formato: int64
totalPagesinteger
formato: int32
© 2026 Expedit LawtechFeito para conectar.