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

Получение категории по id

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

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

Категории

Получение информации о категории

Выводит подробную информацию о категориях с заданными идентификаторами.

query Parameters
key
required
string

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

id
required
string

Идентификатор категории или набор идентификаторов, перечисленных через запятую. Конфликтует с alias.

alias
required
string
Example: alias=avtozapchasti_dlya_inomarok

Название псевдонима категории. Конфликтует с параметром id.

region_id
required
string
Example: region_id=1

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

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": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    },
  • "result": {
    • "total": 1,
    • "items": [
      ]
    }
}