Pessoas

Buscar pessoas do cliente (paginado) para seleção.

GET · API de Integração v2

GET/v2/pessoas/opcoes

Retorna 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

pageinteger

Página (1-based)

padrão: 1
perPageinteger

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

qstring

Texto de busca (nome)

situacaostring

Situaçã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

Exemplo · HTTP 200
{
  "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
documentostring

CPF ou CNPJ

exemplo: 000.000.000-00
idinteger

ID da pessoa

formato: int64exemplo: 123
nomestring

Nome da pessoa

exemplo: João da Silva
pageinteger
formato: int32
perPageinteger
formato: int32
totalinteger
formato: int64
totalPagesinteger
formato: int32
© 2026 Expedit LawtechFeito para conectar.