Sign in

v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Categories

Get All or Several Categories

Get a list of all available location categories, or specific location categories based on the following parameters

get/categories

Query parameters

categoriesinteger

The uberall unique id of the category you want to get

qstring

Filter categories by a search query

rootsboolean

Set to 'true' to show root categories as well (i.e., show all categories)

languagestring required

Show categories in the specified language. One of de, en, es, fr

maxinteger

Used for pagination. Maximum number of results per page. Default: 10

offsetinteger

Offset used for pagination. Default: 0

Response

Successfully retrieved categories

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "max": 1,
    "count": 1,
    "results": {
      "resultTotalCount": 1
    },
    "suggestionResults": {
      "suggestionsTotalCount": 1,
      "suggestions": [
        {
          "id": 41,
          "name": "Avión",
          "fullName": "Automóvil y Transporte > Aeropuerto, Aerolíneas y Servicios de Aviación > Avión",
          "keyword": "Automóvil y motor"
        }
      ]
    }
  }
}