v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de Leads

Este método permite obter uma lista de leads na conta

get/api/v4/leads

Query parameters

withstring

Este parâmetro aceita uma string que pode consistir em vários valores (veja a tabela acima) separados por vírgulas.

pageinteger

Página da lista de leads

limitinteger

O número de entidades retornadas por solicitação (limite – 250)

querystring

Consulta de pesquisa (pesquisa nos campos preenchidos da entidade)

order[created_at]'asc' | 'desc'

Ordenação dos resultados

order[updated_at]'asc' | 'desc'

Ordenação dos resultados

order[id]'asc' | 'desc'

Ordenação dos resultados

filter[id][]integer[]

Filtrar por ID do lead

filter[name][]string[]

Filtrar por nome do lead

filter[price]integer

Filtrar por preço do lead

filter[created_by][]integer[]

Filtrar por ID do usuário que criou a entidade

filter[updated_by][]integer[]

Filtrar por ID do usuário que alterou a entidade por último

filter[responsible_user_id][]integer[]

Filtrar por ID do usuário responsável pela entidade

filter[created_at][from]integer

Filtrar pela data de criação do lead. Data no formato Unix Timestamp

filter[created_at][to]integer

Filtrar pela data de criação do lead. Data no formato Unix Timestamp

filter[updated_at][from]integer

Filtrar pela data da última atualização do lead. Data no formato Unix Timestamp

filter[updated_at][to]integer

Filtrar pela data da última atualização do lead. Data no formato Unix Timestamp

filter[closed_at][from]integer

Filtrar pela data de fechamento do lead. Data no formato Unix Timestamp

filter[closed_at][to]integer

Filtrar pela data de fechamento do lead. Data no formato Unix Timestamp

filter[closest_task_at][from]integer

Filtrar leads pela data da tarefa mais próxima da conclusão. Data no formato Unix Timestamp

filter[closest_task_at][to]integer

Filtrar leads pela data da tarefa mais próxima da conclusão. Data no formato Unix Timestamp

filter[pipeline_id][]integer[]

Filtrar por ID do pipeline

filter[statuses][0][pipeline_id]integer

Deve ser usado com filter[statuses][0][status_id]. O filtro permite filtrar leads com base em seus estágios específicos.

filter[statuses][0][status_id]integer

Deve ser usado com filter[statuses][0][pipeline_id]. O filtro permite filtrar leads com base em seus estágios específicos.

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "LINK"
    }
  },
  "_embedded": {
    "leads": [
      {
        "id": 152462,
        "name": "Lead",
        "price": 15000,
        "responsible_user_id": 8375357,
        "status_id": 58141807,
        "pipeline_id": 6950551,
        "created_by": 8375357,
        "created_at": 1686673336,
        "updated_at": 1686747000,
        "closest_task_at": 1686850200,
        "custom_fields_values": [
          {
            "field_id": 184994,
            "field_name": "Sale",
            "field_type": "checkbox",
            "values": [
              {
                "value": true
              }
            ]
          }
        ],
        "account_id": 31361463,
        "source_id": 20692839,
        "is_price_modified_by_robot": true,
        "_links": {
          "self": {
            "href": "LINK"
          }
        }
      }
    ]
  }
}