---
title: "List Categories"
method: GET
path: "/tasks/v1/customerconfiguration/categories"
tags: ["Issues"]
---

# List Categories

`GET /tasks/v1/customerconfiguration/categories`

## Request

- Base URL: `https://api.mitti.com`
- URL: `https://api.mitti.com/tasks/v1/customerconfiguration/categories`
- Auth: HTTP bearer

## Query parameters

- `include_deleted` boolean
- `search` string
- `category_ids` string[]
- `page_token` string
- `page_size` integer
- `sort_direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
- `is_managing` boolean

## Response `200`

A successful response.

- S12TasksV1GetCategoriesResponse: GetCategoriesResponse represents the response to a GetCategories request. It is an array of `Category`, containing data about the organization's categories.
  - `categories` S12TasksV1Category[]: A list of the categories that are configured for the organisation
    - `id` string: The UUID of a category.
    - `key` string: The name of a category. This can be a default name or one that is customized in your organization.
    - `label` string: The name of a category. This field's value is the same as the value for `key`.
    - `description` string: The description of a category.
    - `display_order` integer: The sorting order of a list of categories. This is unused, and is hardcoded as `0`.
    - `is_visible` boolean: The indicator for whether a category is visible or not for an organization on the web app and the mobile app.
    - `use_category_access_whitelist` boolean: The indicator for whether a category's issues can be accessed by anyone in your organization or not. If this is `false` for a category, then that category's issues can only be accessed by creators and assignees.
    - `items` S12TasksV1Item[]: List of all items to be used in the category
      - `id` string: The UUID of the item.
      - `name` string: Name of the item
      - `is_mandatory` boolean: Whether or not the item must be filled before submission
      - `type` 'ITEM_TYPE_UNSPECIFIED' | 'ITEM_TYPE_TITLE' | 'ITEM_TYPE_DESCRIPTION' | 'ITEM_TYPE_SITE' | 'ITEM_TYPE_MEDIA' | 'ITEM_TYPE_LOCATION' | 'ITEM_TYPE_QUESTION' | 'ITEM_TYPE_OCCURRED_AT' | 'ITEM_TYPE_ASSET': - ITEM_TYPE_UNSPECIFIED: The item type is unspecified
      - `question_data` S12TasksV1Question: Question represents the question structure for a custom question.
        - `id` string: The UUID of the question.
        - `text` string: The text of the question being asked (e.g. "How many eggs are in a dozen?"). This does not use the new `validator.string` option as question processing logic fails when symbols are substituted for similar-looking symbols.
        - `type` 'QUESTION_TYPE_UNSPECIFIED' | 'QUESTION_TYPE_TEXT' | 'QUESTION_TYPE_MULTIPLE_CHOICE': - QUESTION_TYPE_UNSPECIFIED: The question type is unspecified. This generally should not happen. - QUESTION_TYPE_TEXT: The question is text type. This question accepts freetext answers. - QUESTION_TYPE_MULTIPLE_CHOICE: The question is multiple choice. This question provides a list of options to choose from.
        - `is_mandatory` boolean: Whether the question is mandatory or not
        - `multiple_choice_options` S12TasksV1MultipleChoiceOptions: MultipleChoiceOptions is an explicit message for a set of MultipleChoiceOption's to use in a oneof field below.
          - `options` S12TasksV1MultipleChoiceOption[]
            - `id` string: The UUID of the multiple choice option.
            - `text` string: The text of the multiple choice option. This does not use the new `validator.string` option as question processing logic fails when symbols are substituted for similar-looking symbols.
      - `is_disabled` boolean: Whether or not the item is disabled and hidden from submission
    - `notification_detail` 'CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED' | 'CATEGORY_NOTIFICATION_DETAIL_PRIVATE' | 'CATEGORY_NOTIFICATION_DETAIL_SUMMARY' | 'CATEGORY_NOTIFICATION_DETAIL_FULL': CategoryNotificationDetail represents the different level of detail for category notifications. - CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED: CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED is the default value and should not be used. - CATEGORY_NOTIFICATION_DETAIL_PRIVATE: CATEGORY_NOTIFICATION_DETAIL_PRIVATE notifications will be restricted to public metadata. - CATEGORY_NOTIFICATION_DETAIL_SUMMARY: CATEGORY_NOTIFICATION_DETAIL_SUMMARY notifications will include public and private metadata. - CATEGORY_NOTIFICATION_DETAIL_FULL: CATEGORY_NOTIFICATION_DETAIL_FULL will include all metadata and detailed responses.
    - `linked_template_ids` string[]: The list of template ids linked to this category.
    - `visibility_summary` S12TasksV1CategoryVisibilitySummary
      - `users` integer: The number of users that are the category is directly visible to
      - `groups` integer: The number of groups that the category is directly visible to
      - `sites` integer: The number of sites that the category is directly visible to
    - `user_access_as_reporter` 'CATEGORY_USER_ACCESS_AS_REPORTER_UNSPECIFIED' | 'CATEGORY_USER_ACCESS_AS_REPORTER_ALWAYS' | 'CATEGORY_USER_ACCESS_AS_REPORTER_NEVER' | 'CATEGORY_USER_ACCESS_AS_REPORTER_WHEN_SITE_MEMBER'
  - `next_page_token` string: NextPageToken to get the next set of categories. Empty if scrolled to the end.
  - `total` integer: Total number of categories

## Other responses

- `default`: An unexpected error response.

---

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