Skip to main content
GET
List the disputes that use an evidence library document
Each result is one dispute and the version of the document it uses. A dispute that uses two versions of the document appears twice. Results are ordered by linkedAt, newest first. Use links to go to the next or previous page. If your credentials can access only some workspaces, the list shows only the disputes in those workspaces. Returns 404 when the document does not exist, when your credentials cannot access it, or when the evidenceLibraryEnabled feature flag is off.

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

documentId
string<uuid>
required

Identifier of the resource in Payrails.

Query Parameters

filter[version]
integer<int64>

List only the disputes that use this version number.

Required range: x >= 1
filter[defenseStatus]
string

List only the disputes with one of these defense statuses, comma-separated (e.g. Won,Lost).

page[after]
string

Search collection items after that cursor. Cursor for paging results.

page[before]
string

Search collection items before that cursor. Cursor for paging results.

page[size]
integer<int32>

Number of results on a page. The default is 25.

Required range: 1 <= x <= 100

Response

One page of the disputes that use the document.

results
object[]
required
Maximum array length: 100