v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB

items

Get CRM entity items list

Returns a paginated list of CRM entity items with metadata. Supports pagination via page and list query parameters. Example: GET /crm/v1/entities/leads?page=1&list=20

get/crm/v1/entities/{entity}

Query parameters

pageinteger

Current page

listinteger

How many items should be per page

Response

Successful response

Example response

{
  "data": [
    {
      "title": "Lead example",
      "owner": 1,
      "source": "shop",
      "email": [
        {
          "id": "",
          "type": "main",
          "value": "stark@gmail.com",
          "main": true
        },
        {
          "id": "01gdnpddf5xgzxqvcn4x83mc2s",
          "type": "work",
          "value": "benner@gmail.com",
          "main": false
        }
      ],
      "phone": [
        {
          "id": "01gdnpddf5xgzxqvcn4x83mc2s",
          "type": "WORK",
          "value": "+380123456789",
          "code": "+380"
        }
      ],
      "messengers": [
        {
          "id": "01gdnpddf5xgzxqvcn4x83bn2s",
          "type": "facebook",
          "link": "https://www.facebook.com"
        }
      ],
      "id": 12,
      "created_by": 1,
      "changed_by": 1,
      "created_at": 12156465,
      "updated_at": 12156465
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": 1,
    "lastPage": 1,
    "links": [
      {
        "label": "Previous"
      }
    ],
    "path": "https://domain.uspacy.ua/crm/v1/entities/leads",
    "perPage": 20,
    "to": 2,
    "total": 2
  }
}