Get category by id

• Categories
  • getGetting information about a category

API docs by Redocly

Directory of categories (2.0)

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

Categories

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.
alias required	string Example: alias=avtozapchasti_dlya_inomarok The name of the category alias. Conflicts with the id parameter.
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. List of available fields: items.region_id — unique identifier of the project; items.is_reviewable_on_flamp — whether to allow reviews of the organizations of this column directly on flamp.ru; items.rubrics — an array of children categories; items.rubrics.region_id — the ID of the region; items.rubrics.is_reviewable_on_flamp — whether to allow reviews of the organizations of this column directly on flamp.ru.

Responses

Response Schema:

application/jsontext/xmlapplication/json

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/jsontext/xmlapplication/json

{

• "meta": {

  • "code": 200,
  • "api_version": "dev",
  • "issue_date": "string"

  },
• "result": {

  • "total": 1,
  • "items": [

    • {

      • "id": "4503719886454906",
      • "type": "general_rubric",
      • "region_id": "1",
      • "is_reviewable_on_flamp": true,
      • "keyword": "Milk chocolate",
      • "alias": "avarijjnye_sluzhby",
      • "rubrics": [

        • {

          • "id": "4503719886454906",
          • "type": "rubric",
          • "region_id": "1",
          • "alias": "avarijjnye_sluzhby",
          • "org_count": "10",
          • "branch_count": "25",
          • "icon_url": "string",
          • "search_attributes": {

            • "suggested_text": "string",
            • "additional_info": { },
            • "dgis_address_details": {

              • "apartment": "15",
              • "precision": "string",
              • "address": "12",
              • "entrance": "1"

              },
            • "external_source": 1,
            • "additional_context": [

              • 0

              ],
            • "suggest_parts": [

              • {

                • "text": "string",
                • "is_suggested": true

                }

              ]

            },
          • "name": "Emergency services",
          • "geo_count": "2",
          • "parent_id": "4503719886460203",
          • "keyword": "Milk chocolate",
          • "title": "string",
          • "seo_name": "Emergency (emergency on-call) service",
          • "tag": "string",
          • "caption": "string"

          }

        ],
      • "name": "Emergency services",
      • "branch_count": "25",
      • "geo_count": "10",
      • "org_count": "10"

      }

    ]

  }

}