Get branch by id. /2.0/catalog/branch/get

The coordinates of the upper left vertex of a rectangular visibility scope, in the `lon, lat` format. The parameters `viewpoint 1` and `viewpoint 2` transmit the area of the map where the user looked before entering the request. It is used as one of the criteria for choosing where results are needed and for ranking. Does not strictly restrict the search results to the transmitted area only.

viewpoint1

The coordinates of the lower right vertex of a rectangular visibility scope, in the `lon, lat` format. The parameters `viewpoint 1` and `viewpoint 2` transmit the area of the map where the user looked before entering the request. It is used as one of the criteria for choosing where results are needed and for ranking. Does not strictly restrict the search results to the transmitted area only.

viewpoint2

Sorting of results. Valid values: <ul> <li>`relevance` — by descending order of the relevance. The search involves the company name and categories, to which the company belongs. It takes into account a maximum of different factors: the accuracy of matching the request to the object, the popularity of objects, rating, location, advertising and much more;</li> <li>` distance ` by ascending order of the distance. Distance is calculated up to the center of the areal map objects (cities, districts, etc.) and by the shortest distance to the line (street). If the `sort_point` parameter has been passed, the distance is calculated up to this point;</li> <li>`rating` — by descending order of the rating;</li> <li>`flamp_rating` — by descending rating on Flamp;</li> <li>`creation_time` — by descending order of the date of the establishment of the company branch;</li> <li>`bound` — by the visible part of the map. You should pass the `point1` and `point2` parameters;</li> <li>`opened_time` — by descending order of the opening date.</li> <li>`name` - by the name (in alphabetical ascending order).</li> </ul>

sort

The time when the advertising weights were generated in the TIMESTAMP format

Available, if you can use color coding, for example for metro stations.

Route type. 

Possible values:

 * `bus`;
 * `trolleybus`;
 * `tram`;
 * `shuttle_bus`;
 * `metro`;
 * `suburban_train`;
 * `funicular_railway`;
 * `monorail`;
 * `river_transport`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro`;
 * `aeroexpress.

Station type. 

Possible values:

 * `stop` — ground transportation stop;
 * `railway` — railway station;
 * `metro`;
 * `river_transport`;
 * `trolleybus`;
 * `tram`;
 * `funicular_railway`;
 * `monorail`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro`.

Address where a company branch is located.

Clarification on the branch location at the specified address.

Presentation of the address field as a single string.

The time when the information on the branch was added to the database.

Number of employees in the company. This field is available only for commercial API. 

Available options:

 * no data
 * up to 15
 * 16-100
 * 101-250
 * 251-1000
 * more than 1000

Information about floors of the building.

Address view as a single line with indication of the city.

An attribute of availability of information on apartments in the building

If true, it is possible to travel toward the object, if false or unavailable, then it is not.

Individual taxpayer identification number. This field is available only for commercial API.

Linked objects.

Possible values:

 * `entrances` — entry points;
 * `database_entrances` — entry points;
 * `branches` — companies;
 * `servicing` — service providers;
 * `providers`;
 * `airports`;
 * `parking` — parking lots;
 * `nearest_parking`;
 * `nearest_stations`;
 * `railway_terminals` — railway stations;
 * `bus_terminals` — bus stations;
 * `hotels`;
 * `river_ports` — river ports;
 * `seaports` — sea ports;
 * `attractions` — attractions;
 * `landmarks` — reference points.

Full proper name of the branch or a company name.

The coordinates of the search point specified in the WGS84 coordinate system in the lon, lat format.

Description of the purpose of the building.

Parameters of the search result. It is only returned in search methods of the version 3.0.

The ID of the object data source. If absent, the data source is 2GIS.

A set of blocking attributes that match the query.

The data on the number of apartments and the material the building is made of. This field is available only for commercial API.

Timezone offset in minutes with respect to UTC0.

The license of the branch. This field is available only for commercial API.

Type of object. 

Possible values:

 * `branch` — company branch.

branch

Number of company branches in this metacategory.

Short caption for the icon to be displayed in the UI.

Number of geo objects in this metacategory.

Number of companies in this metacategory.

A search string that is put in a search string and that is passed to the query to generate the search results.

The ID of a metacategory the branches of which it is necessary to find.

An attribute indicating that the query requires the closest objects.

A sign that the most relevant result was found by a partial match.

An attribute indicating that the query requires objects not sensitive to the distance. For example, delivery.

GTA banners.

The unique identifier of the building to which this address is linked.

Building name (in the address for branches).

An array of address components. 

Possible values:

 * `street_number` — typical address;
 * `number` — only building number;
 * `location` — generic description.

A verbal description of the structure location.

location

FIAS code. This field is available only for commercial API.

Building number, including fractions and letters. It may be a proper name, if it is used like this.

number

Building number, including fractions and letters.

street_number

Belonging to the administrative territory.

Territory name (to use it for the "share" functionality, for final points of the route, etc.).

Detailed type of administrative-territorial unit.

 Possible values:

 * `city` — a city;
 * `microdistrict` — a microdistrict;
 * `residential_district` — a residential area;
 * `residential_quarter` — a block;
 * `poselok` — a village;
 * `residential_complex` — a residential complex;
 * `selo` — a village;
 * `derevnja` — village;
 * `cottage_estate` — cottage settlement;
 * `urban_settlement` — urban-type settlement;
 * `workers_settlement` — work settlement;
 * `dacha_settlement` — country village;
 * `resort_settlement` — resort village;
 * `stanitsa` - village;
 * `sloboda` — sloboda;
 * `khutor` — farmstead;
 * `aul` — aul;
 * `aal` — aal;
 * `town` — (military) town;
 * `farmstead` — zaimka;
 * `vyselok` — settlement;
 * `municipality` — municipality;
 * `station` - station;
 * `townhouse_settlement` - settlement of townhouses;
 * `territory` — territory;
 * `cooperative` — cooperative;
 * `partnership` — partnership.

The ID of the administrative unit object.

Is filled in only for type=city and takes a single true value if the city is the main city of the current project (e.g. Novosibirsk).

The ID of the administrative unit object. 

Possible values:

 * `city`;
 * `settlement`;
 * `division`;
 * `district`;
 * `living_area` — neighborhood, residential community;
 * `place`;
 * `district_area`;
 * `region` – region/province/republic, etc;
 * `country`

A list of actions for external advertising resources.

Advertising materials for donors of APP ("Advertisement in Partners' Profiles").

Advertising materials for the owner of the owned category.

Advertising materials for donors of FMCG.

Advertising materials for the owner of FMCG.

Contains full name (for sole proprietor) or name (for legal entity), form of ownership (sole proprietor, LLC, etc.).

An indication that a branch or organization has stories.

Indicates the presence of an advertising poi on the map.

A list of additional attributes in this group.

A sign that is there is an intersection between the context categories and the categories of additional attributes of this group.

A sign that is there is an intersection between the primary categories of the branch and the categories of additional attributes of this group.

Name of the group of additional attributes.

An array of IDs of categories linked to a group of additional attributes

Alias of the city, where the object is located.

The key describes the value of the workload score for which time intervals and days are set. Acceptable score values: 1 - 10. Not all points may be present in the data.

The key describes the day of the week for which the intervals with the specified score are presented. Acceptable values: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun".

The values of the intervals are 0 - 23. (0 — from 0 to 1, 23 - from 23 to 24 hours).

Contact value for displaying on the screen.

Type of contact.

Possible values:

 * `email`;
 * `website`;
 * `phone`;
 * `fax`;
 * `icq`;
 * `jabber`;
 * `skype`;
 * `vkontakte`;
 * `twitter`;
 * `instagram`;
 * `facebook`;
 * `pobox`;
 * `youtube`;
 * `odnoklassniki` — ok.ru;
 * `googleplus`;
 * `linkedin`;
 * `pinterest`;
 * `whatsapp`;
 * `telegram`;
 * `viber`;
 * `jivo`.

A distance to a certain point in meters. It is calculated with respect to the point specified in the request in `point` or `sort_point` parameter, and in passed parameter `sort=distance`.

Whether the object is within the boundaries of the sorting.

The code of the group of service providers.

The codes of groups of service providers.

The date when a company was open in the ISO 8601 format.

The date when a company was deleted from the database in the ISO 8601 format.

The date when company data was last updated in the ISO 8601 format.

An object describing properties of the company's delivery

Contact telephone number of the company for order placement

The most relevant category for full-text search (the q parameter).

Possible values:

 * `geo` — map object;
 * `branch`;
 * `transport` — (route, stop, stopping platform).

Cities in case of an unsuccessful search.

Context categories of an unsuccessful search.

Permission to send an email to the company.

email address a user should use to send emails to the company.

Additional data of the branch, such as booklets and photos.

Album code.

Possible values:

 * `common`;
 * `view`;
 * `facilities`.

A URL of the main photo of the branch in 2GIS business listings.

Type of booklet.

Possible values:
 * `buildings`;
 * `saunas`.

A title of the personal page of the branch in 2GIS business listings.

An address of the personal page of the branch in 2GIS business listings.

A code of the personal page of the branch in 2GIS business listings.

URL of the main photo of the branch discounts in 2GIS business listings.

Address of the branch discounts in 2GIS business listings.

Code of the branch discounts in 2GIS business listings.

Is filled in only for type=city and takes a single true value if the city is the main city of the current project (e.g. Novosibirsk)

Is filled in only for type=adm_div, subtype=city|settlement and takes a single true value if the settlement is a district center.

Is filled in only for type=adm_div, subtype=city|settlement and accepts a single true value if the settlement is a regional center.

Whether there are pictures for the object.

A string whose presence indicates that the branch is temporarily not working. The line shows the code of the reason for closing.

Further information on temporarily closed branch.

The identifier of a default floor to be displayed on the map when showing floors of the building.

An array of floors of the building. Sorting: from the lower floors to the top ones.

Geometry of the area used to determine whether the cursor is in the object zone.

A sign that it is the main object in the group of the hybrid objects.

Subtype of the merged object. 

Possible values:

 * `place`;
 * `stop` — public transport stop;
 * `railway` – railway station;
 * `metro` – subway station;
 * `river_transport` — river port;
 * `trolleybus`;
 * `tram`;
 * `funicular_railway`;
 * `monorail`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro.

Type of object.

Possible values:

 * `branch`;
 * `building`;
 * `attraction`;
 * `adm_div` — administrative division of territories;
 * `station`;
 * `station_platform`;
 * `station_entrance`.

The ID of the algorithm, which was used to choose a banner. For fallback banners their algorithm IDs will be used. For GTA there will be a single algorithm 17. The algorithm ID is needed for BSS, in order to distinguish between old and new banners explicitly, and not by the combination of the availability/unavailability of fields in the banner.

The ID of the auction which was held to get this ID of the branch. This identifier should be passed to a bss when sending the impression.

Will be completed with the version of the advertising materials. It is used to hide the specific banner on the side of the product and for its further resuming (similar logic when resuming the display of the context banner).

In the discovery output, it indicates the priority of the banner when it is displayed (0 is the highest, 2 is the lowest).

The ID of the category in which this banner has been found by the old algorithm.

The hash used to register a business connection as well as the openings of the branch.

The ID of the first sections of the branch.

Whether the advertiser has the benefits package.

Number of branches for which you can write a review on flamp.ru.

Information about the apartments in the building.

Number of the building to which the entrance is linked. Unloaded only when the entrances to residential buildings have their own individual addresses.

Number of entrance to residential building.

If available and equal to true, then POI is displayed for this entrance.

Unavailable for entrances without apartments. Must be identical for entrances with the same name.

If available and equal to true, the entrance is displayed in the list of entrances.

Unavailable for entrances with complex geometry.

Number of the last apartment of the range.

Number of the first apartment of the range.

A positive value of the number change step, it is 1 by default.

Number of the entrance to the station, if the object is an entrance.

Distance from the described object to the nearest stopping platform of this stop in meters.

Unique identifier of the reference point.

A stop ID for the "stopping platform", "metro entrance" types.

Subtype of the object. Use `place` for a place. For the stopping platform use the list of possible subtypes:

 * `stop` — public transport stop;
 * `railway` – railway station;
 * `metro` – subway station;
 * `river_transport` — river port;
 * `trolleybus`;
 * `tram`;
 * `funicular_railway`;
 * `monorail`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro`.

Type of the object.

Possible values:

 * station_platform — stopping platform;
 * station_entrance — the entrance to the station;
 * building;
 * branch — company branch;
 * adm_div — administrative unit.

The distance from the described object to the nearest metro station in meters.

Additional comment to the name of the stop, such as the name of the metro line (or lines), to which the station is linked.

Icon. Present if there are routes passing through the platform.

An array of types of transport passing through this stop.

The type of transition. 

Possible values:

 * `ground` — ground;
 * `underground` — underground;
 * `direct` — direct accessibility, from one station you immediately get to another.

Whether there is an underground connection with this station from the described object.

Parking lot capacity (number of parking spaces).

The ID of a separate parking lot object, is any.

Purpose of parking lot.

Possible values:

 * `car` — for cars;
 * `bike` — for bicycles;
 * `motorbike` — for motorcycles/mopeds.

Additional information about the name of the branch that needs to be shown in an open card.

A text reflecting the purpose of the CTA. If this field is available, it should be used as the text on the button.

Action name. If the field is unavailable, use the common localized phrase "Find out more".

Type of action.

Possible values:

 * link — web link;
 * phone — call by specified phone number;
 * callback — a callback request;
 * open_card — opening of a card of a directory object;
 * search_by_org – find all the branches of a company;
 * search_by_rubric – find all the branches of a category;
 * search_by_query — search by text; * search_buy_here — expand donors list of buy here; * search_by_meta_rubric - find all branches of metacategory; * miniapp_yclients - running miniapp yclients, only inside buy_here, is added to the end of the list; * miniapp_otello - running miniapp otello, only inside buy_here, is added to the end of the list.

Correspondence of types of action and the values of the value field:
 * link — the URL of the page you need to open;
 * phone — phone number in the +<digits without separators> format;
 * callback — the URL of the page where you need to send data to request a callback;
 * open_card — the ID of the directory object the card of which you need to open;
 * search_by_org — the ID of the company the branches of which you need to find;
 * search_by_rubric — the ID of the category, the branches of which you want to find;
 * search_by_query – the text of the query by which you need to search; * search_buy_here – list of AdsId from the array objects of the buy_where_owner option, separated by commas; * miniapp_yclients - data for launching the miniapp yclients; * miniapp_otello - data for launching the miniapp otello.

RGB representation of the background color under the logo.

A URL to CDN with the background image under the logo (replaces the background color).

A URL to CDN with company logo in png format with transparency (the base image).

RGB representation of the color of the comment text under the logo.

A flag, if true — use the stub. Ignore the other parameters of advertising option.

An indication that the Premium POI advertising option has been purchased.

An object describing properties of an order from the company without delivery but with a cart

Description of the properties of the company.

A URL for registering the business connection of the profile views.

Type of a search query.

Possible values:

 * `recovery` — contextual categories of the request have not been defined;
 * `discovery` — contextual categories of the request have been defined;
 * `discovery_without_rubric` — the object was found by name extension.

Total number of reviews (including reviews without text)

Whether it is necessary to show reviews for the entire company by default, instead of a single branch. Takes the true value if each branch of the company, that have the reviews activated, has more than 50% of the categories from the list.

Whether it is possible to display reviews for this branch, and add new reviews.

The average rating of the company. It is calculated as the average of the ratings of the branches.

The total number of reviews of the organization (the sum of the `general_review_count_with_stars` field for all branches)

Type of category.

Possible values:

 * primary — main;
 * additional;
 * geo.

The start date of the schedule changes work. Format: "YYYY-MM-DD"

End date changes in the schedule. Format: "YYYY-MM-DD"

The localized description of possible changes in opening hours. Used for holidays, time constraints, etc.

A sign that the company is open around the clock 7 days a week. If the field is absent, the company is not considered to be open 24 hours.

The area from which the data has been collected, in order to request the new data when leaving it.

The preferred rectangular area for displaying results on the map. The results may be outside of this area.

Informs if the text is suggested:

 * true - the text was generated by the prompter;
 * false-the text corresponds to a part of the query.

Type of request to send for the statistics.

The algorithm used to choose advertising.

Number of apartments in a residential building. This field is available only for commercial APIs.

The category of the cultural heritage object. This field is available only for commercial API.

The name of the cultural heritage object. This field is available only for commercial API.

Number of elevators. This field is available only for commercial API.

The type of floors. This field is available only for commercial API.

Type of gas supply. This field is available only for commercial API.

The fact that the house is recognized as an emergency. This field is available only for commercial API.

Designation of the material the building is made of. This field is available only for commercial API.

Number of entrances in a residential building. This field is available only for commercial APIs.

Series/project of construction. This field is available only for commercial API.

Year of construction. This field is available only for commercial API.

A description of the groups of filters to be displayed together with the list of objects (quick filters)

A description of the groups of filters to be displayed on a separate page (advanced filters). Dynamic format.

2GIS API Support

Business listing

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

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

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