---
title: "List all cases"
method: GET
path: "/v1/cases"
tags: ["Cases"]
---

# List all cases

`GET /v1/cases`

Returns a list of all cases created in your Dotfile workspace.

---

#### See also  
Learn more about [Cases](./cases-guide)  
Learn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination)

## Query parameters

- `include_custom_properties` boolean
- `external_id` string
- `assignee_id` string
- `name` string
- `tags` string
- `status` 'draft' | 'open' | 'approved' | 'rejected' | 'closed'
- `created_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `updated_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `last_activity_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `sort` string
- `page` number
- `limit` number

## Response `200`

List of cases created in the workspace

**ℹ️ Click to see full payload**

- PaginatedCaseList
  - `data` CaseList[], required
    - `id` string, uuid, required
    - `name` string, required
    - `status` 'draft' | 'open' | 'approved' | 'rejected' | 'closed', required
    - `review` CaseReview, required
      - `id` string, uuid, required
      - `status` 'approved' | 'rejected' | 'closed', required
      - `comment` string, nullable, required
      - `reviewer_type` 'user' | 'system' | 'api', required
      - `user` NestedUser, required
        - `id` string, uuid, required
        - `first_name` string, required
        - `last_name` string, required
        - `email` string, email, required
      - `reviewed_at` string, date-time, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
      - `next_review_at` string, date, nullable, required — Next review date. `null` if no review schedule after this one. Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)
    - `external_id` string, nullable, required
    - `assignee_id` string, nullable, required
    - `space_slug` string, nullable, required
    - `template` TemplateLight, required
      - `id` string, uuid, required
      - `name` string, required
      - `key` string, required
    - `template_id` string, uuid, nullable, required — Prefer using `template.key` instead.
    - `contact_has_actions` boolean, required
    - `reviewer_has_actions` boolean, required
    - `risk` Risk, required
      - `id` string, required
      - `mode` 'automatic' | 'manual', required
      - `level` 'not_defined' | 'low' | 'medium' | 'high' | 'critical' | 'prohibited', required
      - `comment` string, nullable, required
      - `score` number, nullable, required
      - `components` object, nullable, required — Object in a format of `key` (string) / `value` (number)
      - `flags` object, nullable, required — Object in a format of `key` (string) / `value` (boolean)
      - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
      - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `metadata` object, nullable, required — Object in a format of `key` (string) / `value` (string)
    - `last_activity_at` string, date-time, required — Latest activity date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `last_contact_action_at` string, date-time, nullable, required — Latest contact action date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `flags` string[], required — `all_checks_approved` `for_review` `for_first_collect` `for_recollection` `first_collect_completed`
    - `tags` string[], required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `custom_properties` object — Optional custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to read the case. Archived custom properties are omitted.
  - `pagination` Pagination, required
    - `page` number, required — Current page number (defined in query parameter)
    - `limit` number, required — Item count per page (defined in query parameter)
    - `count` number, required — Total items count

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter. - If specified, make sure the value of the `page` or `limit` query parameter are valid. - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.

---

[API](https://skmtc.dev/dotfile/apis/api-specifications.md) · [All operations](https://skmtc.dev/dotfile/apis/api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dotfile/api-specifications/revisions/36393567057b/schema)
