List requests for approval

get

https://your-protect-instance.example.com/api/rest/v2/requests/for-approval

This endpoint returns a list of requests for approval.
Required role: RequestApprover.

Query Params

currencyID

string

Filter on currency ID. Get valid IDs from the currencies endpoint

types

array of strings

Filter on request types. Examples: payment, function_call, ada_delegate, sol_token_burn, xtz_stake ...

types

ids

array of strings

Filter on specific Requests IDs. An empty list will retrieve all request IDs for approval

ids

cursor.currentPage

string

Base64-encoded string representing the current window of data

cursor.pageRequest

string

The page to request, w.r.t the current page.
Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSize

string

The size of the page requested. The handling service should impose a hard limit on this

sortOrder

string

Set this parameter to ASC to get the addresses sorted in ascending order or DESC to get them in descending order.

excludeTypes

array of strings

Exclude request types. Examples: cosmos_delegate, hedera_staking, ada_delegate, xlm_offer_buy, xtz_unstake ...

excludeTypes

externalRequestIDs

array of strings

Filter on external request ID

externalRequestIDs

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.