crm-v2-contacts

Listar contatos

Recupera uma lista paginada de todos os contatos na conta.

Filtro

Propriedades disponíveis para filtro usando RDQL.

PropriedadeTipoDescrição
nameStringFiltra por nome do contato. Suporta busca exata e busca por correspondência de termo (usando operador match ~).
job_titleStringFiltra por título de cargo do contato. Suporta busca exata e busca por correspondência de termo (match).
emailStringFiltra por endereço de e-mail do contato.
phoneStringFiltra por número de telefone do contato.
whatsapp_usernameStringFiltra por username do WhatsApp do contato. Suporta busca exata e busca por correspondência de termo (match).
organization_idStringFiltra por um ID de empresa.
created_atDateTimeFiltra contatos pela data e hora de criação.
updated_atDateTimeFiltra contatos pela data e hora da última atualização.
@<custom_field_slug>StringFiltra por um campo personalizado. Exemplo: cpf:111.111.111-11, erp_id:123.

Ordenação

Propriedades disponíveis para ordenação.

  • name
  • created_at
get/contacts

Request

  • Base URL
    https://api.rd.services
  • URL
    https://api.rd.services/contacts
  • Auth
    none declared

Query parameters

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)

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.