Skip to main content

Get branch by id

API docs by Redocly

Business listing (2.0)

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

Getting a profile of a company branch

Method support discontinued. To obtain information on ID, use 3.0/items/byid method.

query Parameters
key
required
string

A unique key of API user.

id
required
string
Example: id=1234567890_07dd2164eb829f6d7532f9a9b56d3ffd30

The identifier of the company branch.
May also contain a unique hash in id_hash format. It is used to generate the statistics.
You can also pass multiple IDs separated by commas, but not more than 100

fields
Array of strings

Additional fields to display in the response are separated by commas.
List of available fields:

  • items.alias — alias of the organization name;
  • items.region_id — unique project ID;
  • items.segment_id — unique segment ID;
  • items.org - description of the organization's properties;
  • items.point - coordinates of the search point set in the WGS84 coordinate system in lon, lat format;
  • items.adm_div - belonging to the administrative territory;
  • items.dates - time when information about the branch was entered in the database;
  • items.see_also — a list of advertisers for the "see also" block;
  • items.flags — a list of object attributes;
  • items.external_content — additional company data (requires additional permission on API key);
  • items.locale — the current locale for the region;
  • items.address — the address where the organization's branch is located;
  • items.full_address_name — the same as address_name, but with the city specified;
  • items.schedule — branch opening schedule;
  • items.reviews — branch reviews;
  • items.ads — advertising materials of this branch;
  • items.ads.options — advertising options;
  • items.address.is_conditional — flag for "conditional address";
  • items.links — related objects;
  • items.dates.updated_at — date of the last change of information about the organization in ISO 8601 format;
  • items.dates.deleted_at — date when the organization was deleted from the database in ISO 8601 format;
  • items.dates.created_at — date when the organization was opened in ISO 8601 format;
  • items.is_routing_available — flag for whether travel to the object is possible;
  • items.stop_factors — a set of blocking attributes that match the query;
  • items.email_for_sending.allowed — permission to send a message to the company;
  • items.employees_org_count — the number of employees in the organization. This field is only available in the commercial API.
  • items.itin — individual taxpayer number. This field is only available in the commercial API.
  • items.trade_license - branch license. This field is only available in the commercial API;
  • items.group - objects linked to the combined card;
  • items.stat - data for generating statistics messages;
  • hash — base hash;
  • items.description — description of the organization;
  • items.geometry.selection - geometry for selecting the object;
  • items.geometry.hover — geometry of the area used to determine whether the cursor is in the area of the object.
  • items.geometry.style — ID of the style to display;
  • items.geometry.centroid — the visual center of the object's geometry;
  • items.timezone — the object's time zone in POSIX format;
  • items.timezone_offset — the timezone offset in minutes relative to UTC0;
  • items.sources — the source of organization data;
  • items.is_main_in_group — indicates that this is the main object in the group of objects hybrid;
  • items.city_alias — alias of the city, where the object is located;
  • items.congestion — branch congestion;
  • items.poi_category — POI category;
  • search_attributes — information about the search performed.

Responses

Response Schema:
required
object (ObjMeta)

Response metadata

required
object

Main result

Response samples

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