Pessoas
Buscar pessoas do cliente (paginado) para seleção.
GET · API de Integração v2
GET
/v2/pessoas/opcoesRetorna itens { id, nome, documento } paginados, para escolher o pessoaId usado em outras rotas (ex.: POST /v2/agenda). Sem q, lista todas as pessoas do cliente autenticado.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de consulta4
pageintegerPágina (1-based)
padrão: 1
perPageintegerItens por página (default 15, máx 100)
qstringTexto de busca (nome)
situacaostringSituação: ATIVO (default), ARQUIVADO ou TODOS
padrão: ATIVOvalores: ARQUIVADO · ATIVO · TODOS
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 · application/json
{
"content": [
{
"documento": "000.000.000-00",
"id": 123,
"nome": "João da Silva"
}
],
"page": 1,
"perPage": 1,
"total": 1,
"totalPages": 1
}Contrato de respostas
200OK
OK
application/json
contentPessoaResponse[]Ver propriedades
documentostringCPF ou CNPJ
exemplo: 000.000.000-00
idintegerID da pessoa
formato: int64exemplo: 123
nomestringNome da pessoa
exemplo: João da Silva
pageintegerformato: int32
perPageintegerformato: int32
totalintegerformato: int64
totalPagesintegerformato: int32
