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

Получение объекта по id

API docs by Redocly

Справочник организаций (2.0)

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

Получение профиля филиала организации

Поддержка метода прекращена. Для получения информации по идентификатору воспользуйтесь методом 3.0/items/byid.

query Parameters
key
required
string

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

id
required
string
Example: id=1234567890_07dd2164eb829f6d7532f9a9b56d3ffd30

Идентификатор филиала организации.
Может также содержать уникальный хеш в формате id_hash. Необходим для формирования статистики.
Можно также передать несколько идентификаторов через запятую, но не более 100.

fields
Array of strings

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

  • items.alias — псевдоним названия организации;
  • items.region_id — уникальный идентификатор проекта;
  • items.segment_id — уникальный идентификатор сегмента;
  • items.org — описание свойств организации;
  • items.point — координаты точки поиска, заданные в системе координат WGS84 в формате lon, lat;
  • items.adm_div — принадлежность к административной территории;
  • items.dates — время внесения информации о филиале в БД;
  • items.see_also — список рекламодателей для блока «смотри также»;
  • items.flags — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;
  • items.external_content — дополнительные данные филиала (требуется дополнительное разрешение у ключа API);
  • items.locale — текущая локаль для региона;
  • items.address — адрес, по которому располагается филиал организации;
  • items.full_address_name — то же, что и address_name, но с указанием города;
  • items.schedule — расписание работы филиала;
  • items.reviews — статистика по отзывам о филиале;
  • items.ads — рекламные материалы данного филиала;
  • items.ads.options — рекламные опции;
  • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);
  • items.dates.updated_at — дата последнего изменения информации об организации в формате ISO 8601;
  • items.dates.deleted_at — дата удаления организации из базы в формате ISO 8601;
  • items.dates.created_at — дата открытия организации в формате ISO 8601;
  • items.is_routing_available — флаг, возможен ли проезд до объекта;
  • items.stop_factors — набор блокирующих атрибутов, соответствующих запросу;
  • items.email_for_sending.allowed — разрешение на отправку письма в компанию;
  • items.employees_org_count — численность сотрудников организации. Поле доступно только в коммерческом API;
  • items.itin — индивидуальный номер налогоплательщика. Поле доступно только в коммерческом API;
  • items.trade_license — лицензия филиала. Поле доступно только в коммерческом API;
  • items.group — связанные в объединённую карточку объекты;
  • items.stat — данные для формирования сообщений статистики;
  • hash — базовый хеш;
  • items.description — описание организации;
  • items.geometry.selection — геометрия для выделения объекта;
  • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта;
  • items.geometry.style — идентификатор стиля для отображения;
  • items.geometry.centroid — визуальный центр геометрии объекта;
  • items.timezone — временная зона объекта в формате POSIX;
  • items.timezone_offset — смещение таймзоны в минутах относительно UTC0;
  • items.sources — источник данных об организации;
  • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида;
  • items.city_alias — алиас города, в котором находится объект;
  • items.congestion — загруженность филиала;
  • items.poi_category — категория POI;
  • search_attributes — информация о произведённом поиске.

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": [
      ]
    }
}