Get categories
GET/api/v2/categories
Get categories
Request
Query Parameters
Page number. 30 results per page
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
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
Filters categories available for businesses in given country.
If no country is given, then the endpoint returns the list of all existing available categories.
Use country ISO 3166 alpha2 code.
Filter on block_push_long_description_on_gmb
param (boolean indicating if the business long description can be pushed to GMB when the business belongs to this category)
Fuzzy search on gmb_id and names translations
Filter on live_id
parameter value
True: Recover categories which live_id
is null
False: Recover categories which live_id
is not null
Null: Do not filter on live_id
Possible values: [fr
, en
, es
, it
, pt-br
, de
, ar
]
Language to get the category name. If not given, the user's language is used.
Responses
- 200
- 400
- 401
- 403
- 404
This endpoint lets you read and filter through categories.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
categories
object[]
List of categories
Category id
Unique category id. This is the id you should pass in business.categories array when creating/updating a business.
Category name in given language or user's language
names
object[]
Category names translated for available languages
If with_names
is true
Translated category name
Available language in the application
State of category ( OK or DEPRECATED )
Boolean indicating if the business long description can be pushed to GMB when the business belongs to this category
Array of strings representing the list of country codes in which the category is available
If with_countries
is true
Live category id to which the category is mapped (deprecated categories are mapped to the closest category).
Current page number
Last page number
Number of resources complying with filters
{
"categories": [
{
"id": 42,
"gmb_id": "gcid:climbing_gym",
"name": "Cabinet dexpertise comptable",
"names": [
{
"name": "string",
"lang": "FR"
}
],
"state": "OK",
"block_push_long_description_on_gmb": false,
"countries": [
"FR",
"GB",
"IT",
"ES"
],
"live_id": "gcid:sport_club"
}
],
"page": 1,
"max_page": 10,
"count": 287
}