List purchase IDs in a workspace.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contractId?string

Optional filter: return only purchases attributed to this contract.

Formatbyte

cursor?string

Opaque pagination cursor from a previous ListPurchasesResponse. Empty for the first page.

limit?integer

Maximum number of IDs to return. Server caps this at a service-defined upper bound.

Formatint32

status?string

Optional filter: return only purchases in this lifecycle state.

Value in

"PURCHASE_STATUS_UNSPECIFIED" | "PURCHASE_STATUS_PENDING" | "PURCHASE_STATUS_EXECUTING" | "PURCHASE_STATUS_COMPLETED" | "PURCHASE_STATUS_FAILED" | "PURCHASE_STATUS_TRADES_PENDING" | "PURCHASE_STATUS_TRADED" | "PURCHASE_STATUS_ROLLED_BACK"

workspaceId?string

Workspace to list purchases from.

Formatbyte

Response Body

`application/json`

curl -X POST "https://loading/contracts.v1.Contracts/ListPurchases" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "AAECAwQFBgcICQoLDA0ODw==",    "limit": 100,    "cursor": "",    "contractId": "EBESExQVFhcYGRobHB0eHw==",    "status": "PURCHASE_STATUS_PENDING"  }'

{
  "purchaseIds": [
    "MDEyMzQ1Njc4OWFiY2RlZg=="
  ],
  "nextCursor": ""
}

Empty

Request Body

Response Body

200application/json

default

List pending purchases for a specific contract.

List the first page of purchases in a workspace.

`application/json`