Skip to main content
GET
curl
List cases for the application, newest first by default. Every filter and sort option available in the Console’s Cases list is exposed as a query parameter, including full-text search across the subject, tags, case number, and linked session or transaction IDs.

Authorizations

x-api-key
string
header
required

Path Parameters

organization_id
string<uuid>
required

Organization UUID.

application_id
string<uuid>
required

Application UUID.

Query Parameters

limit
integer
default:50

Page size. Defaults to 50.

Required range: x >= 1
offset
integer
default:0

Zero-based offset of the first record.

Required range: x >= 0
status__in
string

Comma-separated statuses to include, e.g. OPEN,AWAITING_USER.

priority
string

Comma-separated priorities to include.

source__in
string

Comma-separated sources to include.

blueprint
string<uuid>

Filter to cases on this blueprint.

assigned_to
string<uuid>

Filter to cases assigned to this user.

unassigned
boolean

true for unassigned cases, false for assigned cases.

tag
string

Filter to cases carrying this exact tag.

Matches title, case_number, tag, subject name/UUID/external ID, linked session UUID, or linked transaction UUID.

date_from
string<date>

Created-at lower bound (inclusive).

date_to
string<date>

Created-at upper bound (inclusive).

due_before
string<date-time>

due_at upper bound.

overdue
boolean

true to return only overdue open/awaiting-user cases.

ordering
enum<string>
default:-created_at

Sort order. due_at sorts nulls last.

Available options:
created_at,
-created_at,
due_at,
-due_at

Response

200 - application/json

Paginated case list.

count
integer

Number of matching rows. Exact up to 100, capped at 100 beyond that for performance. Rely on next being null to detect the last page.

next
string | null

Absolute URL of the next page, or null.

previous
string | null

Absolute URL of the previous page, or null.

results
object[]