crm-v2-leads

Listar leads

Recupera uma lista paginada de leads da conta. A paginação padrão é de 25 registros por página, com no máximo 200.

Filtro

Propriedades disponíveis para filtro usando RDQL.

PropriedadeTipoDescrição
idStringFiltra por um ou mais IDs. Operador in. Exemplo: id:(507f1f77bcf86cd799439011,507f191e810c19729de860ea).
nameStringFiltra pelo nome. Suporta busca exata e correspondência de termo (operador ~). Exemplo: name:~Acme.
ratingIntegerFiltra pela qualificação (1 a 5). Exemplo: rating:(2,3).
statusStringFiltra pelo status. Apenas o operador in. Valores: ongoing, converted, discarded. Exemplo: status:(ongoing,discarded).
stage_idStringFiltra pelo ID da etapa do lead.
source_idStringFiltra pelo ID da fonte.
campaign_idStringFiltra pelo ID da campanha.
organization_idStringFiltra pelo ID da empresa.
contact_idStringFiltra pelo ID de um contato vinculado.
owner_idStringFiltra pelo ID do responsável.
created_atDateTimeFiltra pela data de criação. Aceita intervalo (>=, <=, >, <).
updated_atDateTimeFiltra pela data da última atualização. Aceita intervalo (>=, <=, >, <).

Ordenação

Propriedades disponíveis para ordenação.

  • name
  • created_at
  • rating
get/leads

Request

  • Base URL
    https://api.rd.services/crm/v2
  • URL
    https://api.rd.services/crm/v2/leads
  • Auth
    OAuth 2
    Authorization code: /oauth/authorize
    Token URL: /oauth/token

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.