Пагинация

Постраничный вывод в списочных методах API v2

API v2 разбивает ответы списочных методов на страницы, чтобы большие выборки оставались быстрыми и удобными в обработке.

Используйте параметры page и per_page в списочных методах. В ответе возвращается объект meta с номером текущей страницы, количеством возвращённых записей и размером страницы.

Например, при 100 записях и per_page=25 получится 4 страницы. Увеличивайте page, чтобы последовательно получить их все.

Параметры запроса

ПараметрОбязательныйВалидацияОписание
pageнетДолжно быть целым числомНомер страницы. Если не передан, возвращается первая страница
per_pageнетДолжно быть целым числомКоличество записей на странице

Пример ответа

json
{
  "companies": [
    {
      "id": 26,
      "name": "Company 26"
    },
    {
      "id": 27,
      "name": "Company 27"
    },
    {
      "id": 28,
      "name": "Company 28"
    },
    {
      "id": 29,
      "name": "Company 29"
    }
  ],
  "meta": {
    "page": 2,
    "entries_count": 4,
    "per_page": 25
  }
}

Объект meta

Пример

json
{
  "meta": {
    "page": 2,
    "entries_count": 4,
    "per_page": 25
  }
}

Описание

ПараметрТипОписание
pageIntegerНомер текущей страницы
entries_countIntegerКоличество записей, возвращённых на этой странице
per_pageIntegerЗапрошенное количество записей на странице

Поиск…

Начните вводить запрос