/3.0/rubricator/list

Рубрикатор (3.0)

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

Рубрикатор

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

Осуществляет выдачу списка всех существующих категорий по заданным параметрам.

query Parameters

key required	string Уникальный ключ пользователя API.
region_id	integer Идентификатор региона. Необходимо указать один из параметров: идентификатор региона, координату, либо идентификатор города для определения региона.
point	string Examples: point=82.921663,55.030195 - Долгота и широта Координата для определения региона рубрикатора. Необходимо указать один из параметров: идентификатор региона, координату, либо идентификатор города для определения региона.
geometry_id	integer Идентификатор объекта (города, посёлка и т.д.) для определения региона рубрикатора. Необходимо указать один из параметров: идентификатор региона, координату, либо идентификатор города для определения региона.
locale	string Локаль, с которой производится поиск и отдаются результаты.
parent_id	integer Default: 0 Идентификатор родительской категории.
sort	string Default: "relevance" Сортировка результатов. Допустимые значения: `name` — по наименованию (в алфавитном порядке по возрастанию). Если параметр не передан, сортировка не применяется.

Responses

Response Schema: application/json

required	object (ObjMeta) Метаданные ответа
required	object

Response samples

Content type

application/json

{"meta": {"code": 200,
"api_version": "dev",
"issue_date": "string"
},
"result": {"items": [{"id": "4503719886454906",
"type": "rubric",
"org_count": "10",
"branch_count": "25",
"tag": "appartments",
"owner_id": "string",
"caption": "string",
"icon_url": "string",
"seo_name": "Аварийные (аварийно-диспетчерские) службы",
"title": "Поесть",
"name": "Аварийные службы"
}
],
"total": 1
}
}