input VaultTokensInput
Filter and pagination for the 'vaultTokens' query.
Pagination is Relay cursor-based, not page/offset based — see the Relay Connections spec. Page forward with first + after, or backward with last + before. Either of last or before selects the backward direction, and a request that combines the two directions is rejected as a validation error rather than paged in one of them. Cursors are opaque strings taken from a previous response's pageInfo (or edges[].cursor) — treat them as black boxes, don't build or parse them yourself.
| Field | Type | Description |
|---|---|---|
orgId | ID | Return only tokens belonging to this organization. Omit to list the tokens owned by the caller's own account instead: a platform or agency API key's tokens, or an org key's organization. A session must name one. |
first | Int | Forward pagination: return at most the first N tokens from the start of the result window. Pair with after to walk forward. Do not combine with last/before. When omitted (and no last), a default page size is used. |
after | String | Forward pagination cursor: return the tokens that come after this cursor. Use the pageInfo.endCursor from the previous page. Pair with first. |
last | Int | Backward pagination: return at most the last N tokens nearest the end of the result window. Pair with before to walk backward. Do not combine with first/after. |
before | String | Backward pagination cursor: return the tokens that come before this cursor. Use the pageInfo.startCursor from the previous page. Pair with last. |
type | VaultTokenType | Return only tokens of this kind. Omit to return both cards and bank accounts. |
status | VaultTokenStatus | Return only tokens in this state. Omit to return every state. |
contactId | ID | Return only tokens linked to this contact. |
externalRef | String | Return only tokens carrying this externalRef. |
includeDeleted | Boolean | Include tokens that have been deleted. Defaults to false, so deleted tokens are omitted. Deleted tokens can never be used; include them only to render history. Status is still judged for a deleted token, so the status filter applies to it too. |