Skip to navigation

List approvals

Lists the organisation’s proposals — pending (the default), returned with the reason, or concluded, the audit — across accounts (keys too), addresses, policies, approval rules and notification endpoints, each with the approved record beside it and who may approve. Only the families your capabilities read are listed; mine=true is the items awaiting you. Ordered by family, then entityId.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

statusenumOptional

pending (the default): the rows with a proposal awaiting approval. returned: the rows whose last proposal was withdrawn — by its maker or by a checker, with the reason — and nothing proposed since; the item carries who returned it, when and why. concluded: the rows whose last proposal concluded — the audit list: who proposed it, who approved when, who concluded it and when (the maker, where the count was 0 and the write concluded at once). Any other value refuses 400.

Allowed values:
minebooleanOptional

true: only the pending items awaiting your approval — you are a person holding the family’s approve capability, you are not the maker — nor, when an API key made it, the key’s issuer or the keyHolder its after row names — and you have not approved yet (the approvers list names you; it never names a service client). Its total with include=total is the count for a bell. Absent or false: every item you read; with status=returned or status=concluded it refuses 400, since neither a returned nor a concluded item awaits anybody.

proposedByenumOptional

me: only the proposals you made — pending ones by default, with status=returned the ones returned to you, each with its reason, or with status=concluded the ones that concluded. The one value it takes; any other refuses 400.

Allowed values:
familyenumOptional

Only rows whose family is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection. A family by its resource segment; account-addresses is a declared or observed address awaiting verification, approval-rules a lowering pending on one of your organisation’s approval rules, notifications a new or amended notification endpoint.

entityIdintegerOptional>=1

Only rows whose entityId is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not a positive 32-bit integer) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection.

transferIdstringOptionalformat: "^[1-9][0-9]*$"

Only rows whose transferId is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not a positive 64-bit integer in decimal digits) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection.

transitionenumOptional

Only rows whose transition is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection.

returnedByenumOptional

Only rows whose returnedBy is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection.

Allowed values:
sortstringOptionalDefaults to family,entityId,transferId

Comma-separated family, entityId, transferId, transition, proposedAtNs, requiredApprovals, concludedAtNs, returnedAtNs or returnedBy; prefix - for descending. Default family,entityId,transferId.

limitintegerOptional>=1

Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.

cursorstringOptional<=2048 characters

nextCursor or prevCursor from a previous page, sent with the same filters and the same sort. One that does not decode, or that came from another query, is refused 400 INVALID_CURSOR: drop it and fetch the first page.

includeenumOptional

total adds the exact number of rows matching the filters. This collection has no terminal state, so include takes total alone: deleted is a value off its grammar (400).

Allowed values:
minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

A page of the proposals the caller reads, by family then entityId or in the order sort asks — all of them unless limit is sent; the position it was read at rides the body and the headers.

asOfSeqTsNsstring or nullformat: "^[0-9]+$"

The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

itemslist of objects
nextCursorstring or null

Pass as cursor for the next page. Null on the last page.

prevCursorstring or null

Pass as cursor for the previous page. Null on the first page.

totalinteger or null

Exact count matching the filter. Null unless include=total.

Errors

400
List Approvals Request Bad Request Error
401
List Approvals Request Unauthorized Error
403
List Approvals Request Forbidden Error
503
List Approvals Request Service Unavailable Error