Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-02-1"

Query Parameters

account_id
string

Only disputes filed against this account (biz_ tag). Omit it to cover every account you can read.

first
integer
default:20

Number of results to return from the start of the range.

Required range: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Required range: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order
enum<string>
default:created_at

The field to sort disputes by.

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

Sort direction.

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

Only disputes in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. Inquiries match only the warning_ statuses. A needs_response dispute whose evidence deadline has passed reports and filters as under_review instead.

Available options:
needs_response,
warning_needs_response,
under_review,
warning_under_review,
won,
lost,
prevented,
warning_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.

query
string

Search disputes by dispute ID, payment ID, user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission.

include_connected_accounts
boolean

Also cover the account's connected accounts. Requires account_id, and is a 400 without it. Without query, covers the disputes of the account and every connected account, in any order. The listing is cut off after 10 seconds; add a query to narrow it. With query, matches on dispute, payment, user or membership ID, buyer email, or a card's first 6 or 8 digits and last 4 separated by a space or dash (424242 4242); free-text queries such as a name search only the named account. Connected accounts' disputes are returned only for connected accounts you can read disputes on.

Response

disputes listed

data
object[]
required
page_info
object
required