---
title: "List status groups"
method: POST
path: "/assets/v1/status-groups/list"
tags: ["Assets"]
---

# List status groups

`POST /assets/v1/status-groups/list`

## Request

- Base URL: `https://api.mitti.com`
- URL: `https://api.mitti.com/assets/v1/status-groups/list`
- Auth: HTTP bearer

Lists the status groups in your organization, including each group's status options and the asset types it is assigned to.

## Request body

- S12AssetsV1ListStatusGroupsRequest: The parameters for `ListStatusGroups`

## Response `200`

A successful response.

- S12AssetsV1ListStatusGroupsResponse: Result returned from `ListStatusGroups`
  - `status_groups` S12AssetsV1StatusGroup[]: The list of status groups.
    - `id` string: The identifier of the status group.
    - `name` string: The name of the status group.
    - `description` string: The description of the status group.
    - `options` S12AssetsV1StatusOption[]: The status options belonging to this group, ordered by position ascending. Maximum 10 options per group.
      - `id` string: The identifier of the status option.
      - `name` string: The name of the status option.
      - `color` 'STATUS_BADGE_COLOR_ACCENT' | 'STATUS_BADGE_COLOR_INFO' | 'STATUS_BADGE_COLOR_NEGATIVE' | 'STATUS_BADGE_COLOR_POSITIVE' | 'STATUS_BADGE_COLOR_WARNING' | 'STATUS_BADGE_COLOR_SURFACE': StatusBadgeColor defines the semantic color palette for status badges. - STATUS_BADGE_COLOR_ACCENT: Color is accent - STATUS_BADGE_COLOR_INFO: Color is info - STATUS_BADGE_COLOR_NEGATIVE: Color is negative - STATUS_BADGE_COLOR_POSITIVE: Color is positive - STATUS_BADGE_COLOR_WARNING: Color is warning - STATUS_BADGE_COLOR_SURFACE: Color is surface
      - `position` integer: The display position of the status option within the group.
      - `created_at` string, date-time: Time when the status option was created.
      - `modified_at` string, date-time: Time when the status option was last modified.
    - `created_at` string, date-time: Time when the status group was created.
    - `modified_at` string, date-time: Time when the status group was last modified.
    - `types` S12AssetsV1Type[]: The asset types assigned to this status group.
      - `id` string: The global unique identifier of the type.
      - `name` string: Name of the type.
      - `type` 'TYPE_CATEGORY_UNSPECIFIED' | 'TYPE_CATEGORY_PREDEFINED' | 'TYPE_CATEGORY_CUSTOM': Category of Type. - TYPE_CATEGORY_UNSPECIFIED: Type Category Unspecified. - TYPE_CATEGORY_PREDEFINED: Predefined Type defined by system. - TYPE_CATEGORY_CUSTOM: Custom type defined by organisation.

## 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)
