Skip to main content

List of branches

API docs by Redocly

Business listing (2.0)

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

Getting a list of branches according to parameters

Method support discontinued. To see a list of companies in an organization, a building or a city, use 3.0/items method.

query Parameters
key
required
string

A unique key of API user.

building_id
required
string

Building ID.

org_id
required
string

Company ID.

rubric_id
required
string

Category ID. You need to send the region_id parameter.
You can also send a list of category IDs separated by commas, in this case, all the categories should be from the same region.

region_id
string

Region identifier. It is required if a geographical limit of search has not been specified. Details about the territorial division of the map into regions can be found in the description of the Regions API.

servicing
string

Takes a single value of true. You should pass building_id.

servicing_group
string

Type of the service provider.
Possible values:

  • default — city service providers;
  • internet — Internet service providers;
  • all — all of the above mentioned.
      • .

point
string
Example: point=82.921663,55.030195

A center of the search area (point coordinates in the lon, lat format).
It is used to filter results in circumference.

radius
integer [ 0 .. 40000 ]
Default: 250

Search radius in meters. Used to filter the results in circumference.

point1
string
Example: point1=82.921663,55.030195

The coordinates of the upper left vertex of a rectangular area limiting the search results in the lon, lat format.
It is used to filter results in a rectangular area.
Allowed difference of the point1 and point2 coordinates is not more than 0.06 for lon, and 0.04 (approximately 6.6 x 4.4 km) for lat.
If the parameter q has been passed — the limitations are not imposed.

point2
string
Example: point2=82.921663,55.030195

The coordinates of the lower right vertex of a rectangular area limiting the search results in the lon, lat format.
It is used to filter results in a rectangular area.
Allowed difference of the point1 and point2 coordinates is not more than 0.06 for lon, and 0.04 (approximately 6.6 x 4.4 km) for lat.
If the parameter q has been passed — the limitations are not imposed.

viewpoint1
string
Example: viewpoint1=82.921663,55.030195

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.

viewpoint2
string
Example: viewpoint2=82.921663,55.030195

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.

polygon
string
Example: polygon=POLYGON((82.91259527206421 55.0614369017519,82.90572881698608 55.05902823221974,82.91521310806274 55.05580825372468))

A polygon in WKT format.
It is used to filter the results in an arbitrary area.

page
integer
Default: 1

The number of the requested page.

page_size
integer [ 1 .. 50 ]
Default: 20

Number of search results displayed on one page.

sort
string

Sorting of results. Valid values:

  • 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;
  • 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;
  • rating — by descending order of the rating;
  • flamp_rating — by descending rating on Flamp;
  • creation_time — by descending order of the date of the establishment of the company branch;
  • bound — by the visible part of the map. You should pass the point1 and point2 parameters;
  • opened_time — by descending order of the opening date.
  • name - by the name (in alphabetical ascending order).

fields
Array of strings

Additional fields to be displayed in the response should be separated by commas.
List of available fields:

  • items.see_also — list of «see also»;
  • items.description — description of the organization;
  • items.geometry.selection — geometry for object selection;
  • items.geometry.hover — the field geometry used for determining the contact cursor into a zone of the object.
  • items.geometry.style — the ID of the style to display;
  • items.geometry.centroid — the visual center of geometry of the object.
  • items.timezone — time zone object in the POSIX format;
  • items.timezone_offset — the offset the offset at the minute regarding UTC0;
  • items.sources — a data source about the organization;
  • items.is_main_in_group — a sign that it is the main object in the object group of hybrid;
  • items.name_ex part of the name of the organization;
  • items.alias is the alias name of the organization;
  • items.region_id — unique identifier of the project;
  • items.segment_id — unique identifier of segment;
  • items.org — describes the properties of the organization;
  • items.point — the coordinates of the search points defined in the WGS84 coordinate system in the format lon, lat;
  • items.adm_div — belonging to the administrative area;
  • items.dates — the time of making of information on the location in the database;
  • items.flags — the list of object characteristics;
  • items.external_content — additional company data (requires additional permission on API key);
  • items.locale — the current locale for the region;
  • items.address — address which is a branch of the organization;
  • items.full_address_name — same as address_name, but with the city name;
  • items.schedule — schedule of work of the branch;
  • items.reviews — statistics on branch reviews;
  • items.ads promotional material of this branch;
  • items.ads.options — advertising options;
  • items.links — related objects;
  • items.dates.updated_at date of last change of information on the organization in the ISO 8601 format;
  • items.dates.deleted_at — date of deletion of the organization from the database in the ISO 8601 format;
  • items.dates.created_at — the date of the opening of the organization in the ISO 8601 format;
  • items.is_routing_available — flag, is it possible to travel to the object;
  • items.stop_factors — a set of locking attributes corresponding to the query;
  • items.contact_groups — the contacts of the branch;
  • items.rubrics — filed under affiliate;
  • items.attribute_groups — additional attributes of the branch;
  • items.reg_bc_url — enrollment URL of the business konnekshn view profile;
  • items.email_for_sending.allowed — permission to send a letter to the company;
  • items.employees_org_count — the number of employees of the organization. Field is available only in commercial API;
  • items.itin — the individual number of the taxpayer. Field is available only in commercial API;
  • items.trade_license — the license of the branch. Field is available only in commercial API;
  • items.group — related to the integrated card objects;
  • items.stat — data to generate message statistics;
  • items.congestion — branch congestion;
  • items.has_discount — there are discounts;
  • items.poi_category — POI category;
  • context_rubrics — an array of contextual headings;
  • request_type — type the search request;
  • search_type — the request type to send in the statistics;
  • dym — the block «you Probably mean»;
  • hash — underlying hash;
  • search_attributes — information about the performed search;
  • filters — filters for additional search.
  • widgets — widgets;
  • cb — the shortcut banner.

locale
string

The locale with which the search is performed and given results.

opened_after_date
string
Example: opened_after_date=2001-01-24

Filters companies which have the opening date later than the passed parameter.
Accepts values in the YYYY-MM-DD format.

itin
string

Individual taxpayer identification number.

work_time
string

Opening hours of the company. Format: [day],[time] or now (current day and time).
Examples:

  • Monday, 17:00 — mon,17:00
  • Thursday, 9:00 — thu,09:00
  • Today, 9:00 — today,09:00
  • Friday, all day — fri,alltime
  • Now now

has_reviews
boolean

Filter by availability of reviews on flamp.ru. Takes the true or false values.

has_photos
boolean

Filter by availability of photos. Takes the true or false values.

has_site
boolean

Filter by availability of website. Takes the true or false values.

has_rating
boolean

Filter by availability of rating on flamp.ru. Takes the true or false values.

has_itin
boolean

Filter by availability of the individual taxpayer identification number. It takes the true or false values.

city_id
string

The IDs of the city separated by commas. They are used to filter branches by cities.
The maximum number is 50.

district_id
string

The IDs of the districts, separated by commas. They are used to filter branches by district.
The maximum number is 50.

Responses

Response Schema:
required
object

Main result

required
object (ObjMeta)

Response metadata

Response samples

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