---
title: "Get All or Several Categories"
method: GET
path: "/categories"
tags: ["Categories"]
---

# Get All or Several Categories

`GET /categories`

## Request

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

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

## Query parameters

- `categories` integer
- `q` string
- `roots` boolean
- `language` string
- `max` integer
- `offset` integer

## Response `200`

Successfully retrieved categories

- object
  - `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
  - `message` string: (optional) Holds further information about the response
  - `warnings` string[]: (optional) Holds further warnings
  - `response` object, required: The actual response object of the response
    - `max` integer: The max number of results
    - `offset` integer: The offset
    - `count` integer: The total count of results
    - `results` object: Results
      - `resultTotalCount` integer: Result total count
      - `results` object[]: Result categories
        - `id` integer: The PromoRepublic unique id for the category
        - `name` string: The category description
        - `selectable` boolean: Boolean indicating whether the category can be used
        - `fullName` string
        - `parent` integer: The parent category
    - `suggestionResults` object
      - `suggestionsTotalCount` integer: Suggestions total count
      - `suggestions` object[]: suggestions
        - `id` integer: The id of the suggestion
        - `name` string: The name
        - `fullName` string: The full name
        - `keyword` string: The keyword

## Other responses

- `400`: Bad Request - The request was invalid or cannot be otherwise served
- `401`: Unauthorized - Authentication credentials are missing or invalid
- `403`: Forbidden - The request is understood, but has been refused or access is not allowed
- `404`: Not Found - The requested resource could not be found

---

[API](https://skmtc.dev/promorepublic/apis/listings-api.md) - [All operations](https://skmtc.dev/promorepublic/apis/listings-api/llms.txt) - [OpenAPI document](https://skmtc.dev/promorepublic/apis/listings-api/revisions/a04c07676a6e?raw)