List approval requests

Retrieve the pending approval requests the authenticated API user is eligible to act on, including requests the user has already approved that are still pending overall.

The response is scoped to the authenticated user by default. Pass userId to read another user’s queue, or includeAllUsers=true to read every pending request in the workspace. Both require an Admin, Non-Signing Admin, Security Admin or Security Auditor role and are rejected with 403 otherwise.

Set quorumStatusMode=SUMMARY to include each request’s approval thresholds and counts. The per-approver breakdown is available only when fetching a single request — see GET /approvals/{requestId}.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin, Security Auditor.

GET

approvals

TypeScript

const response: Promise<FireblocksResponse<ListApprovalsResponse>> = fireblocks.approvalsBeta.getApprovals(approvalsBetaApiGetApprovalsRequest);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/approvals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/approvals"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/approvals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "requestPayload": {
        "requestId": "ccr-1f2e3d4c",
        "requestType": "ADD_USER",
        "requestTimestamp": 1750000000000,
        "expiresAt": 1750600000,
        "requestData": {
          "type": "ADD_USER",
          "creator": "user-1f2e3d4c",
          "id": "ccr-1f2e3d4c"
        }
      },
      "userStatus": "USER_NOT_APPROVED"
    }
  ],
  "next": "cursor for the next page"
}

{
  "message": "<string>",
  "code": 123
}

Query Parameters

includeUserApproved

boolean

When true, also include requests the authenticated user has already approved that are still pending overall. Defaults to false (only requests the user has not yet acted on).

userId

string

Return the pending requests for this user instead of the authenticated user. Requires an Admin, Non-Signing Admin, Security Admin or Security Auditor role; other roles are rejected with 403. Cannot be combined with includeAllUsers=true — sending both is rejected with 400.

includeAllUsers

boolean

default:false

When true, return every pending request in the workspace instead of a single user's queue. Defaults to false. Requires an Admin, Non-Signing Admin, Security Admin or Security Auditor role; other roles are rejected with 403. In this mode userStatus is always USER_STATUS_NOT_APPLICABLE, because the response is not scoped to one user, and includeUserApproved has no effect. Cannot be combined with userId.

quorumStatusMode

enum<string>

default:NONE

How much quorum detail to include in each request's quorumStatus. NONE (the default) returns it as null. SUMMARY returns the approval thresholds, current counts and status. FULL is rejected with 400 on this endpoint because the per-approver breakdown requires a single request — use GET /approvals/{requestId} for it. Any other value is rejected with 400; the parameter is case-sensitive.

Available options:

NONE,

SUMMARY

pageSize

integer

default:20

Number of results per page. Maximum 30. Defaults to 20.

Required range: 1 <= x <= 30

pageCursor

string

Cursor returned from the previous response (the next field) to fetch the next page.

Response

Approval requests the authenticated user is eligible to act on.

data

object[]

required

The approval requests the authenticated user is eligible to act on.

Show child attributes

Example:

[
  {
    "requestPayload": {
      "requestId": "ccr-1f2e3d4c",
      "requestType": "ADD_USER",
      "requestTimestamp": 1750000000000,
      "expiresAt": 1750600000,
      "requestData": {
        "type": "ADD_USER",
        "creator": "user-1f2e3d4c",
        "id": "ccr-1f2e3d4c"
      }
    },
    "userStatus": "USER_NOT_APPROVED"
  }
]

string

Cursor for the next page of results. Pass it back as the pageCursor query param to fetch the next page. Empty or absent when this is the last page.

Example:

"cursor for the next page"

TypeScript

const response: Promise<FireblocksResponse<ListApprovalsResponse>> = fireblocks.approvalsBeta.getApprovals(approvalsBetaApiGetApprovalsRequest);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/approvals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/approvals"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/approvals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "requestPayload": {
        "requestId": "ccr-1f2e3d4c",
        "requestType": "ADD_USER",
        "requestTimestamp": 1750000000000,
        "expiresAt": 1750600000,
        "requestData": {
          "type": "ADD_USER",
          "creator": "user-1f2e3d4c",
          "id": "ccr-1f2e3d4c"
        }
      },
      "userStatus": "USER_NOT_APPROVED"
    }
  ],
  "next": "cursor for the next page"
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

List approval requests

Query Parameters

Response