v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

crm-v2-contacts

Listar contatos

Recupera uma lista paginada de todos os contatos na conta.

Propriedades disponíveis para filtro usando RDQL.

Propriedade	Tipo	Descrição
name	String	Filtra por nome do contato. Suporta busca exata e busca por correspondência de termo (usando operador match ~).
job_title	String	Filtra por título de cargo do contato. Suporta busca exata e busca por correspondência de termo (match).
email	String	Filtra por endereço de e-mail do contato.
phone	String	Filtra por número de telefone do contato.
whatsapp_username	String	Filtra por username do WhatsApp do contato. Suporta busca exata e busca por correspondência de termo (match).
organization_id	String	Filtra por um ID de empresa.
created_at	DateTime	Filtra contatos pela data e hora de criação.
updated_at	DateTime	Filtra contatos pela data e hora da última atualização.
@<custom_field_slug>	String	Filtra por um campo personalizado. Exemplo: cpf:111.111.111-11, erp_id:123.

Propriedades disponíveis para ordenação.

get/contacts

filterstring

Filtro no formato RDQL. (Saiba mais)

sortobject

Ordenação. (Saiba mais)

numberinteger

Número da página.

sizeinteger

Tamanho da página.

Paginação. (Saiba mais)