Pular para o conteúdo principal
GET
curl

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de consulta

counterparty
string<uuid>

Somente os contatos desta entrada do diretório. Deve ser um UUID; um valor vazio significa nenhum filtro.

limit
integer

Tamanho da página, padrão 50.

Intervalo obrigatório: x >= 1
offset
integer

Linhas a ignorar.

Intervalo obrigatório: x >= 0

Resposta

Os contatos.

count
integer
next
string | null
previous
string | null
results
object[]
Última modificação em 1 de novembro de 2026