Список с фильтрами и пагинацией — HTTP 200
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
массив | да | нет | — |
data[] |
объект | да | нет | — |
data[].id |
целое число | да | нет | — |
data[].title |
строка | да | нет | — |
data[].description |
строка / null | да | да | — |
data[].scope_type |
строка | да | нет | — |
data[].customer_id |
целое число / null | да | да | — |
data[].customer_site_id |
целое число / null | да | да | — |
data[].service_contract_id |
целое число / null | да | да | — |
data[].workshop_id |
целое число | да | нет | — |
data[].equipment_ids |
массив | да | нет | — |
data[].equipment_ids[] |
целое число | да | нет | — |
data[].equipment_model_ids |
массив | да | нет | — |
data[].equipment_model_ids[] |
строка | да | нет | — |
data[].device_type_ids |
массив | да | нет | — |
data[].device_type_ids[] |
целое число | да | нет | — |
data[].excluded_equipment_ids |
массив | да | нет | — |
data[].excluded_equipment_ids[] |
целое число | да | нет | — |
data[].trigger_type |
строка | да | нет | — |
data[].type |
строка | да | нет | — |
data[].priority |
строка | да | нет | — |
data[].schedule_mode |
строка / null | да | да | — |
data[].anchor_date |
строка / null | да | да | — |
data[].calendar_interval_value |
целое число / null | да | да | — |
data[].calendar_interval_unit |
строка / null | да | да | — |
data[].calendar_pattern |
строка | да | нет | — |
data[].week_days |
массив | да | нет | — |
data[].week_days[] |
целое число | да | нет | — |
data[].month_days |
массив | да | нет | — |
data[].month_days[] |
целое число | да | нет | — |
data[].usage_interval |
целое число / null | да | да | — |
data[].usage_lead |
целое число | да | нет | — |
data[].usage_unit_id |
целое число / null | да | да | — |
data[].equipment_date_field |
строка / null | да | да | — |
data[].starts_on |
строка | да | нет | — |
data[].ends_on |
строка / null | да | да | — |
data[].generation_time |
строка | да | нет | — |
data[].lead_time_days |
целое число | да | нет | — |
data[].completion_window_value |
целое число / null | да | да | — |
data[].completion_window_unit |
строка | да | нет | — |
data[].scenario_id |
целое число / null | да | да | — |
data[].assigned_user_id |
целое число / null | да | да | — |
data[].scenario_defaults |
объект | да | нет | — |
data[].scenario_defaults.{ключ} |
строка / логическое значение / массив / объект / null | нет | да | — |
data[].scenario_defaults.{ключ} (вариант 3) |
массив | нет | нет | — |
data[].scenario_defaults.{ключ} (вариант 3)[] |
строка | да | нет | — |
data[].scenario_defaults.{ключ} (вариант 4) |
объект | нет | нет | — |
data[].scenario_defaults.{ключ} (вариант 4).amount |
строка | да | нет | — |
data[].scenario_defaults.{ключ} (вариант 4).currency |
строка | да | нет | — |
data[].status |
строка | да | нет | — |
data[].revision |
целое число | да | нет | — |
data[].synced_at |
строка / null | да | да | — |
data[].links |
объект | да | нет | — |
data[].links.edit |
строка / null | да | да | — |
data[].links.portal |
строка / null | да | да | — |
data[].links.public |
строка / null | да | да | — |
data[].version |
строка | да | нет | — |
data[].updated_at |
строка / null | да | да | — |
links |
объект | да | нет | — |
links.self |
строка | да | нет | — |
links.next |
строка / null | да | да | — |
links.prev |
null | да | да | — |
meta |
объект | да | нет | — |
meta.per_page |
целое число | да | нет | — |
meta.has_more |
логическое значение | да | нет | — |
meta.next_cursor |
строка / null | да | да | — |
meta.server_time |
строка | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": [
{
"id": 101,
"title": "Плановый осмотр",
"description": null,
"scope_type": "пример",
"customer_id": null,
"customer_site_id": null,
"service_contract_id": null,
"workshop_id": 101,
"equipment_ids": [],
"equipment_model_ids": [],
"device_type_ids": [],
"excluded_equipment_ids": [],
"trigger_type": "пример",
"type": "preventive",
"priority": "пример",
"schedule_mode": null,
"anchor_date": null,
"calendar_interval_value": null,
"calendar_interval_unit": null,
"calendar_pattern": "пример",
"week_days": [],
"month_days": [],
"usage_interval": null,
"usage_lead": 1,
"usage_unit_id": null,
"equipment_date_field": null,
"starts_on": "пример",
"ends_on": null,
"generation_time": "2026-11-04T09:00:00Z",
"lead_time_days": 1,
"completion_window_value": null,
"completion_window_unit": "пример",
"scenario_id": null,
"assigned_user_id": null,
"scenario_defaults": {},
"status": "active",
"revision": 1,
"synced_at": null,
"links": {
"edit": null,
"portal": null,
"public": null
},
"version": "1793782800",
"updated_at": null
}
],
"links": {
"self": "/api/v1/customers",
"next": null,
"prev": null
},
"meta": {
"per_page": 1,
"has_more": false,
"next_cursor": null,
"server_time": "2026-11-04T09:00:00Z"
}
}