Skip to main content
GET
/
platform
/
admin
/
proposals
List transaction proposals
curl --request GET \
  --url https://api.example.com/platform/admin/proposals
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Fetches a comprehensive report of all transaction proposals in the multi-approval workflow system. Each proposal represents a blockchain transaction requiring multiple custodian approvals before execution.

​
Input

No request body required. The tenant context is determined from the authenticated platform session.

​
Output

Returns a containing:
  • proposals (array) — Collection of transaction proposals with details including proposal ID, transaction data, approval status, threshold requirements, and current state (Pending, Approved, Executed, Cancelled).
  • totalCount (int) — Total number of proposals in the system.

​
Examples

Request 
GET /api/platform/tenant/transaction-proposals
Response (200 OK) 
{
  "proposals": [
    {
      "proposalId": 10001,
      "walletTenantId": 2048,
      "transactionType": "Transfer",
      "status": "Pending",
      "approvalsReceived": 2,
      "approvalsRequired": 3,
      "createdDate": "2024-11-01T10:30:00Z"
    },
    {
      "proposalId": 10002,
      "walletTenantId": 3001,
      "transactionType": "Deploy",
      "status": "Approved",
      "approvalsReceived": 3,
      "approvalsRequired": 3,
      "createdDate": "2024-11-02T14:15:00Z"
    }
  ],
  "totalCount": 2
}

​
Errors

  • 401 Unauthorized: Caller is not authenticated with valid platform credentials.
  • 403 Forbidden: Caller lacks permission to view transaction proposals for this tenant.
  • 500 Internal Server Error: An unexpected error occurred while retrieving proposals.

​
Notes

Proposals in “Pending” state require additional approvals. Once the approval threshold is met, proposals move to “Approved” and can be executed. Executed proposals show blockchain transaction hashes.

Query Parameters

​
api-version
string | null

Response

Transaction proposals report retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "transactionProposals": [
    {
      "proposalId": 10001,
      "blockchainId": 137,
      "blockchainName": "Polygon",
      "createdDate": "2024-01-10T12:00:00Z",
      "walletName": "Main Wallet",
      "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "operationType": "Mint",
      "nonce": "15",
      "status": "Pending",
      "requiredSignatures": 2,
      "signaturesCollected": 1,
      "isApproveAvailable": true,
      "isExecuteAvailable": false,
      "isCancelAvailable": true
    }
  ]
}