GET /api/v4/leads

Changed on

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

Request

  • Base URL
    https://.amocrm.ru
  • Auth
    HTTP bearer

Query parameters

pageinteger

Pagination page

limitinteger

Pagination limit

string
OR
integer

Search by query string or id

withstring

Expand related entities; comma-separated values

orderobject

Sorting, e.g. order[updated_at]=asc

filterobject

Filtering parameters, see filters API

Response

The request has succeeded.

_pageinteger
_linksobject

Changes

    • breaking

      the response's body type changed from no type to object for status (media type: application/json)

    • breaking

      the response's body type changed from no type to object for status (media type: application/hal+json)

    • info

      removed from the response body anyOf list for the response status (media type: application/json)

    • info

      removed from the response body anyOf list for the response status (media type: application/hal+json)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/hal+json)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/hal+json)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/hal+json)

    • info

      added the media type application/hal+json for the response with the status