Перейти к основному содержимому

Список всех категорий

API docs by Redocly

Справочник категорий (2.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Категории

Получение списка категорий по параметрам

Осуществляет выдачу списка всех существующих категорий по заданным параметрам. Использование рекомендовано только для проектов, уже использующих рубрикатор как элемент навигации.

query Parameters
key
required
string

Уникальный ключ пользователя API.

region_id
required
string

Идентификатор региона.

parent_id
string
Default: 0

Идентификатор родительской категории.

page
integer
Default: 1

Номер запрашиваемой страницы.

page_size
integer [ 1 .. 10000 ]
Default: 10000

Максимальное количество результатов на запрашиваемой странице.

sort
string
Default: "name"

Сортировка результатов.
Допустимые значения:

  • name — по алфавиту;
  • popularity — по убыванию популярности.

fields
Array of strings

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую.
Список доступных полей:

  • items.region_id — уникальный идентификатор проекта;
  • items.is_reviewable_on_flamp — разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru;
  • items.rubrics — массив дочерних категорий;
  • items.rubrics.region_id — идентификатор региона;
  • items.rubrics.is_reviewable_on_flamp — разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.

Responses

Response Schema:
required
object (ObjMeta)

Метаданные ответа

required
object

Основной результат

Response samples

Content type
{
  • "meta": {
    • "issue_date": "string",
    • "code": 200,
    • "api_version": "dev"
    },
  • "result": {
    • "total": 1,
    • "items": [
      ]
    }
}