PRpromorepublic
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

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Query parameters

categoriesinteger

The PromoRepublic 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

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"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.