v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB
activities
Get CRM activities list

Returns a paginated list of CRM activities (tasks, calls, meetings, chats, emails). Example: GET /crm/v1/static/tasks?page=1&list=20
get/crm/v1/static/tasks
Query parameters

pageinteger
Current page
listinteger
How many items should be per page
Response

Successful response
Example response

{
  "data": [
    {
      "title": "Title example",
      "startTime": 1674950100,
      "endTime": 1674951000,
      "responsibleId": 5,
      "participants": [
        123,
        234,
        345
      ],
      "contacts": [
        {
          "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"
            }
          ]
        }
      ],
      "deals": [
        {
          "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"
            }
          ]
        }
      ],
      "leads": [
        {
          "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"
            }
          ]
        }
      ],
      "company": {
        "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"
          }
        ]
      }
    }
  ],
  "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
  }
}