Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Categories

Category information

This endpoint lets you retrieve the data of a specific category.

get/categories/{category_id}

Path parameters

integer required

Category id

OR
string required

Google's category id

Query parameters

lang'fr' | 'en' | 'es' | 'it' | 'pt-br' | 'de' | 'ar' | 'nl' | 'pl' | 'cs' | 'ca' | 'sk' | 'pt' | 'lv' | 'ro' | 'bg' | 'hu'

Available language in the application

Example:fr

Language to get the category name. If not given, the user's language is used.

return_liveboolean

Return the corresponding live category instead of the requested category

with_namesboolean

Returns an object representing the list of translations in the available languages for the requested category. See example on the right.

If with_names is true, the translations will appear in the field names

with_countriesboolean

Returns an array of strings representing the list of country codes in which the requested category is available.

If with_countries is true, the country list will appear in the field countries

Response

OK

idinteger

Category id

gmb_idstring

Unique category id. This is the id you should pass in business.categories array when creating/updating a business

namestring

Category name in given language or user's language

statestring

State of category ( OK or DEPRECATED )

block_push_long_description_on_gmbboolean

Boolean indicating if the business long description can be pushed to Google when the business belongs to this category

countriesstring[]

Array of strings representing the list of country codes in which the category is available

If with_countries is true

live_idstring nullable

Live category id to which the category is mapped (deprecated categories are mapped to the closest category)

Example response

{
  "id": 42,
  "gmb_id": "gcid:climbing_gym",
  "name": "Cabinet d'expertise comptable",
  "names": [
    {
      "name": "salle d'escalade",
      "lang": "FR"
    }
  ],
  "state": "OK",
  "countries": [
    "FR",
    "GB",
    "IT",
    "ES"
  ],
  "live_id": "gcid:sport_club"
}