Get category by id
Directory of categories (2.0)
2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/
Getting information about a category
Displays detailed information about categories with specified IDs.
query Parameters
key required | string A unique key of API user. |
id required | string Category ID or the set of identifiers, separated by commas. Conflicts with |
alias required | string Example: alias=avtozapchasti_dlya_inomarok The name of the category alias. Conflicts with the |
region_id required | string Example: region_id=1 Region ID. |
fields | Array of strings Additional fields to be displayed in the response should be separated by commas.
|
Responses
Response Schema: application/jsonapplication/jsontext/xml
application/json
application/json
text/xml
required | object (ObjMeta) Response metadata |
required | object Main result |
https://catalog.api.2gis.com/2.0/catalog/rubric/get
Response samples
- 200
- 400
- 403
- 404
- 500
Content type
application/json
application/json
text/xml
{- "meta": {
- "issue_date": "string",
- "code": 200,
- "api_version": "dev"
}, - "result": {
- "total": 1,
- "items": [
- {
- "id": "4503719886454906",
- "type": "general_rubric",
- "region_id": "1",
- "is_reviewable_on_flamp": true,
- "org_count": "10",
- "alias": "avarijjnye_sluzhby",
- "name": "Emergency services",
- "geo_count": "10",
- "branch_count": "25",
- "keyword": "Milk chocolate",
- "rubrics": [
- {
- "id": "4503719886454906",
- "type": "rubric",
- "region_id": "1",
- "name": "Emergency services",
- "caption": "string",
- "title": "string",
- "branch_count": "25",
- "tag": "string",
- "search_attributes": {
- "dgis_address_details": {
- "address": "12",
- "entrance": "1",
- "apartment": "15",
- "precision": "string"
}, - "suggested_text": "string",
- "suggest_parts": [
- {
- "text": "string",
- "is_suggested": true
}
]
}, - "alias": "avarijjnye_sluzhby",
- "parent_id": "4503719886460203",
- "icon_url": "string",
- "org_count": "10",
- "geo_count": "2",
- "seo_name": "Emergency (emergency on-call) service",
- "keyword": "Milk chocolate"
}
]
}
]
}
}