List | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.operations.cases.listV1({
        sort_by: "created_at",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
        filter_needs_action: true,
        filter_unassigned: true,
    });
}
main();

{
  "items": [
    {
      "schema_version": 1,
      "order_id": "ORD-20240605-1234",
      "_id": "case_987654321",
      "org_id": "org_chrt_001",
      "created_by_user_id": "user_admin",
      "created_at": "2024-01-15T09:30:00Z",
      "department_id": "dept_logistics",
      "assigned_operator_user_ids": [
        "user_jdoe"
      ],
      "status": "open",
      "needs_action": true,
      "messages": [
        {
          "message": "Initial case created for delayed shipment.",
          "user_id": "user_jdoe",
          "org_id": "org_chrt_001",
          "timestamp": "2024-01-15T09:30:00Z"
        }
      ]
    }
  ],
  "total_count": 1
}

Lists cases for the caller’s organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenum or nullOptional

Field to sort by

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc)

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_statusenum or nullOptional

Filter by status(es)

Allowed values:

filter_department_idstring or nullOptional

Filter by department ID(s)

filter_assigned_operator_user_idstring or nullOptional

Filter by assigned operator user ID (matches any case that includes this user)

filter_needs_actionboolean or nullOptional

Filter by needs_action flag

filter_unassignedboolean or nullOptional

Filter for unassigned cases

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Cases List V1request Unprocessable Entity Error