Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-25"

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,
currency
account_id
string

Only disputes filed against this account (biz_ tag).

status
enum<string>[]

Only disputes in these statuses. Repeat the parameter to pass several.

Available options:
needs_response,
under_review,
won,
lost,
closed
currency
string

Only disputes in this three-letter ISO currency.

created_before
string

Only disputes opened before this ISO 8601 timestamp.

created_after
string

Only disputes opened 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 disputes match the filters.