Skip to main content
GET
Listar contatos de signatários
Lista a agenda de signatários do seu projeto. Cada contato armazena dados reutilizáveis (nome, CPF, e-mail, telefone, data de nascimento, qualificação) que podem ser preenchidos automaticamente ao criar envelopes. Autenticação: x-api-key no header. Também aceita Authorization: Bearer com headers de projeto/organização.

Parâmetros

Busca por nome, e-mail ou CPF (case-insensitive). Se contiver dígitos, também busca CPF.
integer
Número da página (padrão: 1).
integer
Itens por página (padrão: 20, máximo: 100).

Respostas

array
Lista de contatos (pode estar vazia).
integer
Total de contatos (filtrando pela busca, se houver).
integer
Página atual.
integer
Itens por página.

Erros

Veja Autenticação e erros.
  • 401: API key inválida.

Exemplo

Importante

  • Escopo por projeto: a agenda é por projeto — você só vê contatos cadastrados no seu projeto.
  • Busca flexível: se a busca contiver dígitos, busca também no CPF.
  • Ordenação: contatos são listados por nome.

Próximas etapas

  1. Use os UUIDs dos contatos em PUT .../signers ao criar envelopes.
  2. Ou use POST .../signer-contact-groups para agrupar contatos (ex.: “Diretoria”).

Relacionado