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

groups
enum<string>[]

Which breakdowns to return, keyed by these names under groups. Repeat the parameter to ask for several; omit it for all of them.

Available options:
status,
reason,
outcome
account_id
string

The account to summarize cases for (biz_ tag).

user_id
string

Only cases opened by this customer — a user_ tag, or me for the calling user.

status
enum<string>[]

Only cases in these statuses.

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

Only cases opened for these reasons.

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

Only closed cases that ended these ways.

Available options:
customer_won,
merchant_won,
withdrawn
created_before
string

Only count cases created before this ISO 8601 timestamp.

created_after
string

Only count cases created after this ISO 8601 timestamp.

Response

summary returned

groups
object
required

One entry per requested breakdown, keyed by the field it groups on. A field you did not ask for is absent.

total
integer
required

How many cases match the filters.

Example:

1