Skip to main content

Get categories

GET 

/api/v2/categories

Get categories

Request

Query Parameters

    page number

    Page number. 30 results per page

    with_names boolean

    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_countries boolean

    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

    country string

    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.

    Example: FR
    block_push_long_description_on_gmb boolean

    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)

    search_query string

    Fuzzy search on gmb_id and names translations

    live__isnull boolean

    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

    lang string

    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

This endpoint lets you read and filter through categories.

Schema

    categories

    object[]

    List of categories

  • Array [

  • id number

    Category id

    gmb_id string

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

    name string

    Category name in given language or user's language

    names

    object[]

    Category names translated for available languages

    If with_names is true

  • Array [

  • name string

    Translated category name

    lang string

    Available language in the application

  • ]

  • state string

    State of category ( OK or DEPRECATED )

    block_push_long_description_on_gmb boolean

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

    countries string[]

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

    If with_countries is true

    live_id string

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

  • ]

  • page number

    Current page number

    max_page number

    Last page number

    count number

    Number of resources complying with filters

Loading...