> For the complete documentation index, see [llms.txt](https://jetbot.gitbook.io/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jetbot.gitbook.io/api/rabota-s-api/spiski/elementy-stroki-spiska.md).

# Элементы (строки) списка

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

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

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

**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,asc` или `created_at,desc` |
| `filters`                                     | object  | Поля для фильтрации данных. Например: `{"name": "Дмитрий"}` или `{"age": ">=,18"}`               |
| `page`                                        | integer | Выбор страницы                                                                                   |
| `limit`                                       | integer | Количество элементов на странице                                                                 |

**Пример:**

{% tabs %}
{% tab title="запрос" %}

```json
{
"api_token" : "{{tokenjb}}",
"schema_id" : "{{schema_id}}",
"order_by" : "age,desc",
"filters" : 
    {
        "name" : "Иван"
    },
"limit" : 3,
"page" : 2
}
```

{% endtab %}

{% tab title="ответ" %}

```json
{
  "data": [
    {
      "id": "6716af611a1fb9c55a0871b4",
      "createdat": "2024-10-21T19:45:37+00:00",
      "updated_at": "2024-10-29T11:33:31+00:00",
      "nametest": "Поддержка",
      "usernametest": "@jetbot_support",
      "age": 1
    },
    {
      "id": "6720c8040f682bb26f076822",
      "created_at": "2024-10-29T11:33:24+00:00",
      "updated_at": "2024-10-29T11:33:24+00:00",
      "nametest": "Поддержка",
      "usernametest": null,
      "age": 2
    },
    {
      "id": "6720c8140867387a4100b4a2",
      "created_at": "2024-10-29T11:33:40+00:00",
      "updated_at": "2024-10-29T11:33:40+00:00",
      "nametest": "Поддержка",
      "usernametest": null,
      "age": 3
    }
  ],
  "links": {
    "first": "https://app.jetbot24.ru/api/v1/getListItems?page=1",
    "last": "https://app.jetbot24.ru/api/v1/getListItems?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Назад",
        "active": false
      },
      {
        "url": "https://app.jetbot24.ru/api/v1/getListItems?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Вперёд &raquo;",
        "active": false
      }
    ],
    "path": "https://app.jetbot24.ru/api/v1/getListItems",
    "perpage": 50,
    "to": 3,
    "total": 3
  }
}
```

{% endtab %}
{% endtabs %}

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

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

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

**Body:**

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

**Пример:**&#x20;

{% tabs %}
{% tab title="запрос" %}

```json
{
  "api_token": "{{tokenjb}}",
  "schema_id": "{{schema_id}}",
  "data": {
    "name": "Петр",
    "usernametest": "{{username}}",
    "age": 10
  }
}
```

{% endtab %}

{% tab title="ответ" %}

```json
{
  "data": {
    "id": "6720ce5bfafa5b1cbe00f463",
    "createdat": "2024-10-29T12:00:27+00:00",
    "updatedat": "2024-10-29T12:00:27+00:00",
    "name": "Петр",
    "usernametest": "@support",
    "age": 10
  }
}
```

{% endtab %}
{% endtabs %}

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

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

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

**Body Request**

<table><thead><tr><th width="192">Name</th><th width="102">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>api_token</code><mark style="color:red;">*</mark></td><td>string</td><td>api токен вашего аккаунта</td></tr><tr><td><code>schema_id</code><mark style="color:red;">*</mark></td><td>string</td><td>ID списка</td></tr><tr><td><code>item_id</code><mark style="color:red;">*</mark></td><td>string</td><td>ID элемента в списке (можно получить при получении элементов списка)</td></tr><tr><td><code>data</code></td><td>object</td><td>Поля элемента. Пример <code>{"slug поля": "значение"}</code></td></tr></tbody></table>

**Response**

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

```json
{
  "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.jetbot24.ru/api/v1/deleteListItem`

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

**Body Request**

<table><thead><tr><th width="159">Name</th><th width="121">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>api_token</code><mark style="color:red;">*</mark></td><td>string</td><td>api токен вашего аккаунта</td></tr><tr><td><code>item_id</code><mark style="color:red;">*</mark></td><td>string</td><td>ID элемента в списке (можно получить при получении элементов списка)</td></tr></tbody></table>

**Response**

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

```json
Response is empty
```

{% endtab %}
{% endtabs %}