Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Query Parameters

account_id
string

Only cases filed against this account (biz_ tag). With read access to the account this lists its whole queue; without, only the cases you opened against it.

user_id
string

Only cases opened by this customer — a user_ tag, or me for the calling user. It narrows what you can already read, so me lists the cases you opened without the ones on accounts you are a team member of.

first
integer

The number of cases to return (default 20, max 100).

after
string

A cursor; returns cases after this position.

last
integer

The number of cases to return from the end of the range.

before
string

A cursor; returns cases before this position.

order
enum<string>
default:created_at

The field to sort cases by.

Available options:
created_at,
response_due_at
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
status
enum<string>[]

Only cases in these statuses. Repeat the parameter to pass several — one paginated list covers all of them.

Available options:
awaiting_merchant,
awaiting_customer,
under_review,
closed
reason
enum<string>[]

Only cases opened for these reasons. Repeat the parameter to pass several.

Available options:
fraudulent,
product_not_received,
not_as_described,
product_unacceptable,
subscription_canceled
outcome
enum<string>[]

Only closed cases that ended these ways. Repeat the parameter to pass several.

Available options:
customer_won,
merchant_won,
withdrawn
created_before
string

Only cases created before this ISO 8601 timestamp.

created_after
string

Only cases created after this ISO 8601 timestamp.

Response

cases listed

data
object[]
required
page_info
object
required