/3.0/rubricator/list

List if categories (3.0)

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

List if categories

Getting a list of categories according to parameters

Provides a list of all available categories for the specified parameters.

query Parameters

key required	string Unique key of API user.
region_id	integer Region ID. You must specify one of the parameters: the region ID, the coordinate, or the city ID to determine the region.
point	string Examples: point=82.921663,55.030195 - Longitude and latitude The coordinate for the region of the rubricator detection. You must specify one of the parameters: the region ID, the coordinate, or the city ID to determine the region.
geometry_id	integer Geographical object (city, settlement, etc.) identifier thart will be used to detect rubricator region. You must specify one of the parameters: the region ID, the coordinate, or the city ID to determine the region.
locale	string The locale with which the search is performed and given results.
parent_id	integer Default: 0 Parent category ID.
sort	string Default: "relevance" The sorting of results. Valid values: `name` — by name (in alphabetical ascending order). If the parameter is not specified, the sorting is not applied.

Responses

Response Schema: application/json

required	object
required	object (ObjMeta) Response metadata

Response samples

Content type

application/json

{"result": {"total": 1,
"items": [{"id": "4503719886454906",
"type": "rubric",
"caption": "string",
"title": "Eat out",
"seo_name": "Emergency (emergency on-call) service",
"branch_count": "25",
"tag": "appartments",
"owner_id": "string",
"icon_url": "string",
"name": "Emergency services",
"org_count": "10"
}
]
},
"meta": {"issue_date": "string",
"code": 200,
"api_version": "dev"
}
}