Docs/Objects/Common objects

Common objects

Shared response envelopes, errors, cursor pagination, and operation status values.

Page#

Field	Type	Required	Meaning
`items`	T[]	yes	Rows for this page.
`page.limit`	number	yes	The applied page size. Defaults to 25 and maxes at 100.
`page.nextCursor`	string \| null	yes	Pass this as the next cursor. Null means no next page.
`page.hasMore`	boolean	yes	True when another page is available.

Pagejson

{
  "items": [],
  "page": {
    "limit": 25,
    "nextCursor": null,
    "hasMore": false
  }
}

Errorjson

{
  "error": "amount must be greater than zero",
  "details": {}
}

Wire values are exact API values. Product labels can be friendlier.

pendingCreatedsubmittedSubmittedminedCompletedrejectedRejectedcancelledCancelled