---
title: "findCategories"
method: GET
path: "/categories"
tags: ["category-endpoint"]
---

# findCategories

`GET /categories`

## Request

- Base URL: `https://localhost:8171`
- URL: `https://localhost:8171/categories`
- Auth: none declared

returns the complete list of categories. These can be optionally filtered by role or group. Though the filtering is performed by the application and not the database.

## Query parameters

- `role` string
- `group` string

## Response `200`

OK

- CategoryDTO[]
  - `group` string
  - `longDescription` string
  - `name` 'ACTION_CANCELLATION_COMPLETED' | 'ACTION_CANCELLATION_CREATED' | 'ACTION_COMPLETED' | 'ACTION_CREATED' | 'ACTION_UPDATED' | 'ADDRESS_OCCUPIED_NO_RESIDENT' | 'CASE_CREATED' | 'COLLECTION_INSTRUMENT_DOWNLOADED' | 'COLLECTION_INSTRUMENT_ERROR' | 'COMPLETED_BY_PHONE' | 'COMPLY_IN_DIFFERENT_COLLECTION_MODE' | 'DISABLE_RESPONDENT_ENROLMENT' | 'EQ_LAUNCH' | 'GENERATE_ENROLMENT_CODE' | 'LACK_OF_COMPUTER_INTERNET_ACCESS' | 'NO_ACTIVE_ENROLMENTS' | 'NO_LONGER_REQUIRED' | 'OFFLINE_RESPONSE_PROCESSED' | 'ONLINE_QUESTIONNAIRE_RESPONSE' | 'PHYSICALLY_OR_MENTALLY_UNABLE' | 'PRIVACY_DATA_CONFIDENTIALITY_CONCERNS' | 'RESPONDENT_ACCOUNT_CREATED' | 'RESPONDENT_EMAIL_AMENDED' | 'RESPONDENT_ENROLED' | 'SECURE_MESSAGE_SENT' | 'SUCCESSFUL_RESPONSE_UPLOAD' | 'UNSUCCESSFUL_RESPONSE_UPLOAD' | 'VERIFICATION_CODE_SENT'
  - `role` string
  - `shortDescription` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2021-10-28** `803bfe28d21e`: 1 warning
  - added the new `RESPONDENT_EMAIL_AMENDED` enum value to the `items/name` response property for the response status `200`
- **2021-10-28** `48b735d77a07`: 4 info
  - removed the `LANGUAGE_DIFFICULTIES` enum value from the `items/name` response property for the response status `200`
  - removed the `NON_RESIDENTIAL_ADDRESS` enum value from the `items/name` response property for the response status `200`
  - removed the `RESPONDENT_EMAIL_AMENDED` enum value from the `items/name` response property for the response status `200`
  - removed the `TOO_BUSY` enum value from the `items/name` response property for the response status `200`
- **2021-07-27** `c0689468d20f`: 18 info
  - removed the `COMMUNAL_ESTABLISHMENT_INSTITUTION` enum value from the `items/name` response property for the response status `200`
  - removed the `DECEASED` enum value from the `items/name` response property for the response status `200`
  - removed the `DWELLING_OF_FOREIGN_SERVICE_PERSONNEL_DIPLOMATS` enum value from the `items/name` response property for the response status `200`
  - removed the `FULL_INTERVIEW_REQUEST_DATA_DELETED` enum value from the `items/name` response property for the response status `200`
  - …14 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/case-service-api/changes/categories/get.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/case-service-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/case-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/case-service-api/revisions/6523753b5522?raw)