> For the complete documentation index, see [llms.txt](https://help.cleverapp.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.cleverapp.pro/dlya-razrabotchikov/dokumentaciya-i-rabota-s-api/spiski/elementy-spiska.md).

# Элементы списка

{% hint style="warning" %}
Как правильно сформировать запрос?! Смотрим в [основах](/dlya-razrabotchikov/dokumentaciya-i-rabota-s-api/osnovy.md)
{% endhint %}

## Получить элементы списка

<mark style="color:green;">`POST`</mark> `https://app.cleverapp.pro/api/v1/getListItems`

Этот метод позволяет получить элементы списка.

#### Request Body

| Name                                         | Type    | Description                                                                                  |
| -------------------------------------------- | ------- | -------------------------------------------------------------------------------------------- |
| schema\_id<mark style="color:red;">\*</mark> | string  | ID списка.                                                                                   |
| bot\_id                                      | integer | ID бота (если есть такое поле)                                                               |
| contact\_id                                  | integer | ID контакта (если есть такое поле)                                                           |
| order\_by                                    | string  | Поле по которому необходимо сделать сортировку. Например: `created_at` или `created_at,desc` |
| filters                                      | object  | Поля для фильтрации данных. Например: `{"name": "Дмитрий"}` или `{"age": ">=,18"}`           |

{% tabs %}
{% tab title="200: OK Запрос успешно обработан" %}

```javascript
{
  "data": [
    {
      "id": "5dee39b68a7ab32ecf060264",
      "contact_id": 1,
      "created_at": "2019-12-09T12:10:30+00:00",
      "updated_at": "2019-12-09T12:10:30+00:00",
      "first_name": "Иван",
      "last_name": "Иванов"
    },
    {
      "id": "5dee39bb6637df57be7bc683",
      "contact_id": 1,
      "created_at": "2019-12-09T12:10:35+00:00",
      "updated_at": "2019-12-09T12:10:35+00:00",
      "first_name": "Петр",
      "last_name": "Петров"
    },
    {
      "id": "5dee39bdc2cc5a38ec797234",
      "contact_id": 1,
      "created_at": "2019-12-09T12:10:37+00:00",
      "updated_at": "2019-12-09T12:10:37+00:00",
      "first_name": "Василий",
      "last_name": "Васильев"
    }
  ],
  "links": {
    "first": "https:\/\/watbot.ru\/api\/v1\/getListItems?page=1",
    "last": "https:\/\/watbot.ru\/api\/v1\/getListItems?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/watbot.ru\/api\/v1\/getListItems",
    "per_page": 50,
    "to": 3,
    "total": 3
  }
}
```

{% endtab %}
{% endtabs %}

## Добавить элемент в список

<mark style="color:green;">`POST`</mark> `https://app.cleverapp.pro/api/v1/addListItem`

Этот метод позволяет добавить элемент в список.

#### Request Body

| Name                                         | Type   | Description                                                             |
| -------------------------------------------- | ------ | ----------------------------------------------------------------------- |
| data<mark style="color:red;">\*</mark>       | object | <p>Поля элемента. <br>Пример <code>{"slug поля": "значение"}</code></p> |
| schema\_id<mark style="color:red;">\*</mark> | string | ID списка.                                                              |

{% tabs %}
{% tab title="201: Created Запрос успешно обработан" %}

```javascript
{
  "data": {
    "id": "5dee62e46637df57be7bc686",
    "contact_id": 443,
    "created_at": "2019-12-09T15:06:12+00:00",
    "updated_at": "2019-12-09T15:06:12+00:00",
    "name": "Товар",
    "quantity": null,
    "is_vip": true,
    "key": "secret"
  }
}
```

{% endtab %}
{% endtabs %}

## Обновить элемент в списке

<mark style="color:green;">`POST`</mark> `https://app.cleverapp.pro/api/v1/updateListItem`

Этот метод позволяет удалить элемент в списке.

#### Request Body

| Name                                   | Type   | Description                                       |
| -------------------------------------- | ------ | ------------------------------------------------- |
| item\_id                               | string | ID элемента в списке.                             |
| data<mark style="color:red;">\*</mark> | object | Поля элемента. Пример `{"slug поля": "значение"}` |

{% tabs %}
{% tab title="200: OK Запрос успешно обработан" %}

```javascript
{
  "data": {
    "id": "5dee62e46637df57be7bc686",
    "contact_id": 1,
    "created_at": "2019-12-09T15:06:12+00:00",
    "updated_at": "2019-12-09T15:09:47+00:00",
    "name": "Товар",
    "quantity": null,
    "is_vip": false,
    "key": "secret"
  }
}
```

{% endtab %}
{% endtabs %}

## Удалить элемент списка

<mark style="color:green;">`POST`</mark> `https://app.cleverapp.pro/api/v1/deleteListItem`

Этот метод позволяет удалить элемент в списке.

#### Request Body

| Name     | Type   | Description           |
| -------- | ------ | --------------------- |
| item\_id | string | ID элемента в списке. |

{% tabs %}
{% tab title="204: No Content Запрос успешно обработан" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}