Grupos de Empresas
Buscar grupos de empresas do cliente (paginado) para seleção.
GET · API de Integração v2
GET
/v2/grupos-empresas/opcoesRetorna 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
pageintegerPágina (1-based)
padrão: 1
perPageintegerItens por página (default 15, máx 100)
qstringTexto 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 · */*
{
"content": [
{
"id": 10,
"nome": "Grupo Exemplo"
}
],
"page": 1,
"perPage": 1,
"total": 1,
"totalPages": 1
}Contrato de respostas
200OK
OK
*/*
contentGrupoEmpresasResponse[]Ver propriedades
idintegerID do grupo de empresas
formato: int64exemplo: 10
nomestringNome do grupo de empresas
exemplo: Grupo Exemplo
pageintegerformato: int32
perPageintegerformato: int32
totalintegerformato: int64
totalPagesintegerformato: int32
