Search for categories

OpenAPI Specification

• Categories
  • getCategories search

API docs by Redocly

Directory of categories (2.0)

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

Categories

Categories search

Performs the search for categories by keywords.

query Parameters

key required	string A unique key of API user.
region_id required	string Region ID.
q required	string [ 1 .. 400 ] characters An arbitrary search string.
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.
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 Main result
required	object (ObjMeta) Response metadata

https://catalog.api.2gis.com/2.0/catalog/rubric/search

Response samples

• 200
• 400
• 403
• 404
• 408
• 500

Content type

application/jsontext/xmlapplication/json

{

• "result": {

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

    • {

      • "id": "4503719886454906",
      • "type": "rubric",
      • "region_id": "1",
      • "caption": "string",
      • "title": "string",
      • "search_attributes": {

        • "additional_context": [

          • 0

          ],
        • "suggest_parts": [

          • {

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

            }

          ],
        • "additional_info": { },
        • "suggested_text": "string",
        • "external_source": 1,
        • "dgis_address_details": {

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

          }

        },
      • "org_count": "10",
      • "tag": "string",
      • "icon_url": "string",
      • "seo_name": "Emergency (emergency on-call) service",
      • "keyword": "Milk chocolate",
      • "name": "Emergency services",
      • "parent_id": "4503719886460203",
      • "branch_count": "25",
      • "geo_count": "2",
      • "alias": "avarijjnye_sluzhby"

      }

    ]

  },
• "meta": {

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

  }

}