---
title: "GET /api/v4/leads"
method: GET
path: "/api/v4/leads"
---

# GET /api/v4/leads

`GET /api/v4/leads`

Get a list of leads (pagination, sorting, filtering).

## Query parameters

- `page` integer
- `limit` integer
- `query` union
  - string
  - integer
- `with` string
- `order` object
- `filter` object

## Response `200`

The request has succeeded.

- union
  - LeadListResponse
    - `_page` integer
    - `_links` object
    - `_embedded` object
      - `leads` Lead[]
        - `id` integer
        - `name` string
        - `price` integer
        - `responsible_user_id` integer
        - `group_id` integer
        - `status_id` integer
        - `pipeline_id` integer
        - `loss_reason_id` integer
        - `source_id` integer
        - `created_by` integer
        - `updated_by` integer
        - `closed_at` integer
        - `created_at` integer
        - `updated_at` integer
        - `closest_task_at` integer
        - `is_deleted` boolean
        - `custom_fields_values` CustomFieldValue[], nullable
          - `field_id` integer — Use either field_id or field_code (e.g. PHONE/EMAIL)
          - `field_code` string — Field code (e.g. PHONE/EMAIL)
          - `values` CustomFieldValueItem[], required — Values for the field (multiple values allowed)
            - `value` union, required
              - …
            - `enum_id` integer — Option id for list/select custom fields (one of predefined options)
            - `enum_code` string — Option code for list/select custom fields (if you use code instead of id)
        - `score` integer, nullable
        - `account_id` integer
        - `labor_cost` integer
        - `is_price_modified_by_robot` boolean
        - `visitor_uid` string
        - `_links` object
        - `_embedded` LeadEmbedded
          - `loss_reason` LossReason
            - `id` integer
            - `name` string
          - `tags` Tag[]
            - `id` integer
            - `name` string
            - `color` string
          - `contacts` LeadContactRef[]
            - `id` integer
            - `is_main` boolean
          - `companies` LeadCompanyRef[]
            - `id` integer
          - `catalog_elements` CatalogElementRef[]
            - `id` integer
            - `metadata` object
          - `source` LeadSourceRef
            - `external_id` union — External id in your system
              - …
            - `type` string — Source type
  - Problem
    - `title` string
    - `status` integer
    - `detail` string
    - `type` string

---

[API](https://skmtc.net/hexlet/apis/amocrm-api.md) · [All operations](https://skmtc.net/hexlet/apis/amocrm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hexlet/amocrm-api/versions/800f4ed7083b/schema)