Search for branches by phone number
Catalog of objects (3.0)
2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/
A collection of objects on the phone
Returns objects to the specified telephone number. Method available at additional cost.
query Parameters
key required | string Unique key of API user. |
phone required | string Phone number, which is used for the search. |
fields | Array of strings Examples:
Additional fields to be displayed in the response should be separated by commas. Fields labeled
The list of fields with additional information on the place:
The list of command boxes:
|
page | integer [ 1 .. 1000000 ] Default: 1 The number of the requested page. |
page_size | integer [ 1 .. 50 ] Default: 20 Number of search results displayed on one page. |
Responses
Response Schema: application/json
required | object (ObjMeta) Response metadata |
required | object Main result |
Response Schema: application/json
object (ObjMetaBadRequest) Response metadata |
Response Schema: application/json
object (ObjMetaForbidden) Response metadata |
Response Schema: application/json
object (ObjMetaNotFound) Response metadata |
Response Schema: application/json
object (ObjMetaTimeout) Response metadata |
Response Schema: application/json
object (ObjMetaServerError) Response metadata |
https://catalog.api.2gis.com/3.0/items/byphone
Response samples
- 200
- 400
- 403
- 404
- 408
- 500
Content type
application/json
{- "result": {
- "total": 1,
- "search_attributes": {
- "is_nearby_requested": true,
- "out_viewport": [
- {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}, - {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}, - {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}, - {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}
], - "drag_bound": [
- {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}
], - "is_partial": true,
- "is_remote_requested": true
}, - "items": [
- {
- "id": "141265769336625_f91d4H3777058262347790J0e8g28765",
- "type": "branch",
- "region_id": "123456",
- "segment_id": "123456",
- "schedule_special": [
- {
- "data": "2025-01-02",
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}
], - "name_ex": {
- "short_name": "Sunny",
- "primary": "Sunny",
- "extension": "cafe",
- "legal_name": "LLC Sunny",
- "addition": "string",
- "description": "Warehouse"
}, - "parking": {
- "payment_link": "string"
}, - "rubrics": [
- {
- "id": "123456",
- "name": "string",
- "alias": "string",
- "parent_id": "123456",
- "kind": "string"
}
], - "has_apartments_info": true,
- "address_comment": "office 413",
- "purpose_name": "string",
- "marker_alt": 0,
- "itin": "1234567890",
- "stop_factors": [
- {
- "type": "attribute",
- "tag": "hotel_details_laundry",
- "name": "Laundry"
}
], - "name": "the Sunny cafe",
- "context": {
- "servicing_groups": [
- "string"
], - "distance": "3483",
- "is_in_bound": "true",
- "stop_factors": [
- {
- "type": "attribute",
- "tag": "hotel_details_laundry",
- "name": "Laundry"
}
], - "servicing_group": "string"
}, - "sources": [
- "string"
], - "schedule": {
- "Sun": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "is_24x7": true,
- "comment": "Open 24h on holidays",
- "description": "string",
- "Mon": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Tue": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "date_from": "string",
- "Wed": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Fri": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Thu": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Sat": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "date_to": "string"
}, - "search_attributes": {
- "external_source": 1,
- "additional_context": [
- 0
], - "dgis_address_details": {
- "address": "12",
- "entrance": "1",
- "apartment": "15",
- "precision": "string"
}, - "suggested_text": "string",
- "suggest_parts": [
- {
- "is_suggested": true,
- "text": "string"
}
]
}, - "point": "54.991984,82.901886",
- "address": {
- "building_code": "string",
- "building_name": "Sun City",
- "landmark_name": "Zaryadye (a park in Moscow)",
- "makani": "27116 87099",
- "components": [
- {
- "type": "street_number",
- "street_id": "123456",
- "street": "Krasnyy Prospekt",
- "number": "21/2, bld 7",
- "fias_code": "dcb1bc1b-2324-449a-8b68-03e49ba1f541",
- "okato": "35",
- "oktmo": "35"
}
], - "building_id": "20498230958",
- "postcode": "630007"
}, - "city_alias": "novosibirsk",
- "order_with_cart": [
- {
- "phone": "+7123456789"
}
], - "building_name": "string",
- "adm_div": [
- {
- "id": "123456",
- "type": "city",
- "is_default": true,
- "flags": {
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "name": "string",
- "value": "string"
}
], - "has_model": { },
- "photos": true,
- "is_default": true,
- "is_region_center": true,
- "is_district_area_center": true
}, - "city_alias": "novosibirsk",
- "detailed_subtype": "poselok",
- "caption": "string",
- "name": "Ust-Kamenogorsk"
}
], - "structure_info": {
- "year_of_construction": 0,
- "elevators_count": 0,
- "material": "string",
- "apartments_count": 0,
- "gas_type": "string",
- "is_in_emergency_state": true,
- "chs_category": "string",
- "project_type": "string",
- "porch_count": 0,
- "chs_name": "string",
- "floor_type": "string"
}, - "description": "string",
- "dates": {
- "created_at": "2012-04-18T12:08:03.273144+07:00",
- "updated_at": "2012-06-18T11:43:03.273144+07:00",
- "deleted_at": "2013-06-01T11:43:03.273144+07:00"
}, - "floor_plans": {
- "plans": [
- {
- "id": "123456",
- "name": "string"
}
], - "default_plan_id": "123456"
}, - "geometry": {
- "centroid": "POINT(83.306820839303 54.6230101954005)",
- "hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
- "selection": "POINT(83.306820839303 54.6230101954005)"
}, - "alias": "shintop_set_avtomarketov",
- "locale": "ru_RU",
- "is_deleted": true,
- "delivery": [
- {
- "phone": "+7123456789"
}
], - "reviews": {
- "review_count": "32",
- "is_reviewable": true,
- "org_rating": "4.73",
- "general_review_count_with_stars": 0,
- "is_org_reviews": true,
- "general_rating": "4.73",
- "org_review_count": 0,
- "general_review_count": 0,
- "rating": "4.73",
- "recommendation_count": "12",
- "items": [
- {
- "tag": "string",
- "is_reviewable": true,
- "rating": 5,
- "review_count": 0,
- "recommendation_count": 0
}
], - "org_review_count_with_stars": 0
}, - "org": {
- "id": "123456",
- "name": "string",
- "branch_count": "7"
}, - "employees_org_count": "up to 15",
- "is_routing_available": true,
- "links": {
- "airports": {
- "items": [
- {
- "id": "123456",
- "name": "Tolmachevo airport",
- "additional_info": "Airport, Ob-4"
}
], - "count": 0
}, - "servicing": {
- "count": 1,
- "allowed_for_reviews_count": 0,
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "org_id": "string",
- "name": "string",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "comment": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null
}
]
}
]
}, - "landmarks": [
- {
- "id": "123456",
- "type": "station_platform",
- "distance": 0,
- "azimuth": 360,
- "subtype": "string",
- "station_id": "123456",
- "name": "string",
- "entrance_display_name": "string"
}
], - "on_territory": {
- "count": 0
}, - "database_entrances": [
- {
- "id": "123456",
- "is_visible_in_ui": true,
- "relative_geometry": {
- "direction": 0,
- "dx": 0,
- "dy": 0
}, - "entrance_display_name": "string",
- "name": "string",
- "is_primary": true,
- "entity_number": "string",
- "is_visible_on_map": true,
- "has_poi": true,
- "geometry": {
- "points": [
- "string"
], - "vectors": [
- "string"
], - "normals": [
- "string"
]
}, - "building_number": "string",
- "entity_name": "string",
- "apartments_info": {
- "calculated": true,
- "floors": [
- {
- "apartments": null,
- "name": null
}
]
}, - "comment": "string"
}
], - "seaports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Marine passenger terminal",
- "additional_info": "Marine Glory square, 1"
}
]
}, - "hotels": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "additional_info": "Mira St, 18a bld1",
- "name": "Aquarius, Motel"
}
]
}, - "nearest_parking": [
- {
- "id": "123456"
}
], - "nearest_metro": [
- {
- "id": "123456",
- "distance": 500
}
], - "railway_terminals": {
- "items": [
- {
- "id": "123456",
- "name": "Novosibirsk-Western, railway station",
- "additional_info": "Shirokaya Street, 26a"
}
], - "count": 0
}, - "entrances": [
- {
- "id": "123456",
- "comment": "string",
- "is_visible_in_ui": true,
- "entity_name": "string",
- "entity_number": "string",
- "entrance_display_name": "string",
- "is_visible_on_map": true,
- "is_primary": true,
- "geometry": {
- "vectors": [
- "string"
], - "normals": [
- "string"
], - "points": [
- "string"
]
}
}
], - "river_ports": {
- "items": [
- {
- "id": "123456",
- "additional_info": "Leningrad highway, 51",
- "name": "Moscow North river terminal"
}
], - "count": 0
}, - "providers": {
- "count": 1,
- "allowed_for_reviews_count": 0,
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "org_id": "string",
- "name": "string",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "comment": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null
}
]
}
]
}, - "branches": {
- "count": 1,
- "allowed_for_reviews_count": 0,
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "org_id": "string",
- "name": "string",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "comment": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null
}
]
}
]
}, - "nearest_platforms": [
- {
- "id": "123456",
- "transition_type": "string",
- "heading_to": "Nakhabino",
- "name": "Krasniy Prospekt metro station",
- "comment": "Leninskaya line",
- "color": "#D10000",
- "route_logo": "string",
- "route_types": [
- "string"
]
}
], - "bus_terminals": {
- "items": [
- {
- "id": "123456",
- "name": "Bus station, Novosibirsk",
- "additional_info": "Krasnyy Prospekt, 4"
}
], - "count": 0
}, - "nearest_stations": [
- {
- "id": "123456",
- "comment": "Leninskaya line",
- "name": "Krasniy Prospekt metro station",
- "route_types": [
- "string"
], - "entrance": {
- "id": "123456",
- "entrance_display_name": "string",
- "geometry": {
- "centroid": "POINT(83.306820839303 54.6230101954005)",
- "hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
- "selection": "POINT(83.306820839303 54.6230101954005)"
}, - "name": "string"
}, - "internal_transition": true,
- "route_logo": "string",
- "color": "#D10000",
- "distance": 0
}
], - "parking": [
- {
- "id": "123456",
- "name": "Underground Parking, Sun City",
- "purpose": "string",
- "capacity": "string",
- "is_paid": true,
- "comment": "50 rub per hour, first 2 hours free."
}
], - "attractions": [
- {
- "id": "123456",
- "authors": "string",
- "dates": "string",
- "description": "string",
- "subtype_name": "Fountain",
- "name": "Fountain in Narymsky public garden"
}
]
}, - "floors": {
- "underground_count": 1,
- "ground_min_count": 1,
- "ground_count": 1
}, - "floor_id": "141832714658709",
- "external_content": [
- {
- "type": "discount",
- "value": "shintop",
- "label": "Open",
}
], - "address_name": "Dimitrov Avenue, 7",
- "attribute_groups": [
- {
- "rubric_ids": [
- "123456"
], - "attributes": [
- {
- "id": "123456",
- "name": "Free Internet in the rooms",
- "icon_url": "string",
- "tag": "hotel_room_internet"
}
], - "icon_url": "string",
- "name": "Hotel",
- "is_context": true,
- "is_primary": true
}
], - "flags": {
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "name": "string",
- "value": "string"
}
], - "has_model": { },
- "photos": true,
- "is_default": true,
- "is_region_center": true,
- "is_district_area_center": true
}, - "ski_lift": {
- "type": 0,
- "status": 0
}, - "trade_license": {
- "type": "string",
- "legal_form": "string",
- "type_description": "string",
- "director_name": "string",
- "license": "string",
- "start_date": "string",
- "end_date": "string"
}, - "ev_charging_station": {
- "aggregate": {
- "is_active": true,
- "is_busy": true,
- "connectors_free": 0,
- "connectors_total": 0,
- "power": 0
}, - "connectors": [
- {
- "type": "string",
- "power": 0,
- "price": 0,
- "status": 0
}
]
}, - "timezone_offset": 420,
- "full_address_name": "Novosibirsk, Dimitrov Avenue, 7",
- "contact_groups": [
- {
- "name": "Service center",
- "comment": "Multichannel phone number",
- "schedule": {
- "Sun": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "is_24x7": true,
- "comment": "Open 24h on holidays",
- "description": "string",
- "Mon": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Tue": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "date_from": "string",
- "Wed": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Fri": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Thu": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Sat": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "date_to": "string"
}, - "schedule_special": [
- {
- "data": "2025-01-02",
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}
], - "contacts": [
- {
- "type": "phone",
- "comment": "for business correspondence",
- "url": "string",
- "value": "Phone number in international format",
- "text": "Ivanov's e-mail",
- "print_text": "Ivanov's e-mail"
}
]
}
], - "full_name": "string"
}
], - "context_rubrics": [
- {
- "id": "string",
- "name": "string",
- "group": 0,
- "caption": "string"
}
]
}, - "meta": {
- "code": 200,
- "api_version": "dev",
- "issue_date": "string"
}
}