---
title: "GET /helpdesk/cases"
method: GET
path: "/helpdesk/cases"
tags: ["Helpdesk"]
---

# GET /helpdesk/cases

`GET /helpdesk/cases`

Lists Helpdesk Case objects available in the collection. If the case has been created not
about a particular product -- the "product" section of the response will not be returned.

## Query parameters

- `limit` integer
- `offset` integer
- `description` string
- `events.closed.at` string, date-time
- `events.closed.by.id` string
- `events.closed.by.name` string
- `events.created.at` string, date-time
- `events.created.by.id` string
- `events.created.by.name` string
- `events.inquiring.at` string, date-time
- `events.inquiring.by.id` string
- `events.inquiring.by.name` string
- `events.pending.at` string, date-time
- `events.pending.by.id` string
- `events.pending.by.name` string
- `events.resolved.at` string, date-time
- `events.resolved.by.id` string
- `events.resolved.by.name` string
- `events.updated.at` string, date-time
- `events.updated.by.id` string
- `events.updated.by.name` string
- `id` string
- `issuer.account.id` string
- `issuer.account.name` string
- `issuer.agent.id` string
- `issuer.agent.name` string
- `priority` 0 | 1 | 2 | 3
- `receiver.account.id` string
- `receiver.account.name` string
- `receiver.agent.id` string
- `receiver.agent.name` string
- `state` 'pending' | 'inquiring' | 'resolved' | 'closed'
- `subject` string
- `type` 'technical' | 'business'

## Response `200`

- HelpdeskCase[]
  - `id` string
  - `product` HelpdeskProduct — Connect Product details. `id` -- id of the product. `name` -- name of the product. `icon` -- icon of the product.
    - `id` string, required
    - `name` string
    - `icon` string, nullable
  - `subject` string, required
  - `description` string, required
  - `priority` string
  - `state` 'pending' | 'inquiring' | 'resolved' | 'closed'
  - `type` 'technical' | 'business', required
  - `issuer` HelpdeskIssuer — Represents the partner information of the Helpdesk Case issuer. . `account` -- account `id`, `name` and `icon`. `agent` -- user details to which the Helpdesk Case is assigned. `recipients` -- additional list of users who will be receiving updated about the Helpdesk Case.
    - `account` HelpdeskAccount — Connect Account details. `id` -- id of the account. `name` -- name of the account. `icon` -- icon of the account.
      - `id` string, required
      - `name` string
      - `icon` string, nullable
    - `agent` HelpdeskActor — Connect User details. `id` -- id of the user. `name` -- name of the user.
      - `id` string, required
      - `name` string, nullable
    - `recipients` HelpdeskActor[]
      - `id` string, required
      - `name` string, nullable
  - `receiver` HelpdeskReceiver, required — Represents the partner information of the Helpdesk Case receiver. . `account` -- account `id`, `name` and `icon`. `agent` -- user details to which the Helpdesk Case is assigned. `recipients` -- additional list of users who will be receiving updated about the Helpdesk Case.
    - `account` HelpdeskAccount, required — Connect Account details. `id` -- id of the account. `name` -- name of the account. `icon` -- icon of the account.
      - `id` string, required
      - `name` string
      - `icon` string, nullable
    - `agent` HelpdeskActor — Connect User details. `id` -- id of the user. `name` -- name of the user.
      - `id` string, required
      - `name` string, nullable
    - `recipients` HelpdeskActor[]
      - `id` string, required
      - `name` string, nullable
  - `events` object
    - `created` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `updated` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `pending` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `inquiring` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `resolved` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `closed` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
  - `rating` string, nullable
  - `feedback` string, nullable

## Other responses

- `400`

---

[API](https://skmtc.net/cloudblue/apis/cloudblue-connect-api.md) · [All operations](https://skmtc.net/cloudblue/apis/cloudblue-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudblue/cloudblue-connect-api/revisions/0421d2a97c52/schema)
