revault-api

Appearance

List requests ​

GET/requests

Query parameters ​

NameTypeDescriptionRequired
page
number
Which page to fetch
min: 1, max: 9007199254740991
pageSize
number
Page size to use
min: 1, max: 30
type
|
Multiple types
|
Single type
Search by request type
state
|
Multiple states
|
Single state
Search by request state
targetId
string
Search by target ID
createdBy
string
Search by request creator (user ID or 'me')
reviewedBy
string
Search by user who has already reviewed (user ID or 'me')
pendingBy
string
Search by user who has a pending review for the request (user ID or 'me')
sortBy
| "state"
| "expiresAt"
| "createdAt"
| "updatedAt"
Sort by attribute
sortOrder
"asc" | "desc"
Sort order

Response schema ​

{
// Current page
page: number;
// Next page or null if there is none
next: number | null;
// Previous page or null if there is none
prev: number | null;
// Max count of items per page
pageSize: number;
// Total count of items
total: number;
// Array of results
results: Array<
|
UPDATE_QUORUM request
|
CREATE_TRANSACTION request
|
SIGN_MESSAGE request
|
SIGN_DIGESTS request
|
CREATE_ACCOUNT request
|
EDIT_ACCOUNT request
|
EDIT_TOKEN_RULE request
|
CREATE_GROUP request
|
EDIT_GROUP request
|
REVOKE_GROUP request
|
CREATE_WHITELIST request
|
EDIT_WHITELIST request
|
CREATE_ENTITY request
|
EDIT_ENTITY request
|
REVOKE_ENTITY request
|
CREATE_PSD_USER request
|
CREATE_API_USER request
|
CREATE_API_USER_ACCESS request
|
REVOKE_USER request
|
EDIT_WORKSPACE_RULE request
|
CREATE_SCICONFIG request
|
EDIT_SCICONFIG request
|
CREATE_API_KEY request
|
EDIT_API_KEY request
|
REVOKE_API_KEY request
|
CREATE_POLICY request
|
EDIT_POLICY request
|
TRADELINK_ACTIVATE_ACCOUNT request
|
TRADELINK_CREATE_CUSTODIAN request
|
TRADELINK_EDIT_CUSTODIAN request
|
TRADELINK_CREATE_EXCHANGE request
|
TRADELINK_EDIT_EXCHANGE request
|
TRADELINK_CREATE_ASSET_MANAGER request
|
TRADELINK_EDIT_ASSET_MANAGER request
|
TRADELINK_ADJUST_PLEDGE request
|
TRADELINK_REPLEDGE request
|
TRADELINK_CREATE_SETTLEMENT request
|
TRADELINK_FORCE_UNPLEDGE request
|
TRADELINK_WITHDRAW request
|
TRADELINK_ARBITRATE request
>;
}

Examples ​

bash
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/requests"
ts
const url = "<base-url>/requests";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});
python
import requests

url = "<base-url>/requests"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

print(requests.get(url, headers=headers))