Списки: фильтры, сортировка, страницы
Методы-списки (например, GET /company/trade/sale) принимают одинаковые параметры. Какие фильтры и связи есть у конкретного списка, указано в таблице «Параметры запроса» на его странице.
| Параметр | Пример | Назначение |
|---|---|---|
filter[<поле>] | filter[status]=completed | Фильтр по полю |
filter[<поле>][] | filter[status][]=completed&filter[status][]=canceled | Несколько значений (IN) |
filter[<дата>][0], [1] | filter[created_at][0]=2026-09-01&filter[created_at][1]=2026-09-30 | Период: с / по |
sort[] | sort[]=-id | Сортировка; - — по убыванию |
with[] | with[]=client&with[]=transactions | Подгрузить связанные данные |
page | page=2 | Номер страницы, с 1 |
page-size | page-size=50 | Записей на странице |
page-size только уменьшает
У каждого списка свой верхний предел (обычно 20). Больший page-size игнорируется, применяется предел.
Неизвестный фильтр или поле сортировки не вызывают ошибку — они просто не применяются. Если список отфильтрован не так, как ожидалось, сверьте имя поля с таблицей на странице.
Ответ
json
{
"data": [ … ],
"links": { "first": "…?page=1", "last": "…?page=3", "prev": null, "next": "…?page=2" },
"meta": { "current_page": 1, "from": 1, "last_page": 3, "per_page": 20, "to": 20, "total": 57 }
}
