Skip to main content
GET
/
categories
List Partoo categories
curl --request GET \
  --url https://api.partoo.co/v2/categories \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "categories": [
    {
      "id": 4018,
      "gmb_id": "gcid:wood_industry",
      "name": "Industrie du bois",
      "state": "OK",
      "block_push_long_description_on_gmb": false,
      "live_id": null
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
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.

​
lang
enum<string>

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

Available options:
fr,
en,
es,
it,
pt-br,
de,
ar,
nl,
pl,
cs,
ca,
sk,
pt,
lv,
ro,
bg,
hu
Example:

"fr"

​
state
enum<string>
Available options:
OK,
DEPRECATED
​
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 Google when the business belongs to this category)

​
search_query
string

Fuzzy search on gmb_id and names translations

​
order_by
enum<string>

Order results by colum. Add "-" before for ordering by descending order.

Available options:
gmb_id,
-gmb_id
​
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

​
page
integer
default:0

Page number. 30 results per page

​
per_page
integer
default:30

Number of items to return per page. Currently limited to 100.

Required range: 1 <= x <= 100
​
with_names
boolean
default:false

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
default:false

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

​
page
integer

Current page number

Example:

1

​
max_page
integer

Last page number

Example:

10

​
count
integer

Number of resources complying with filters

Example:

287

​
categories
object[]

List of categories