Get a single approval request

Retrieve full detail for a single approval request by ID, including the payload to sign and, when requested, the request’s quorumStatus.

Because this endpoint addresses one request, it accepts quorumStatusMode=FULL, which adds the participating approvers and their individual approval state.

userStatus reflects the authenticated user by default. Pass userId to report it for another user instead.

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

GET

approvals

{requestId}

TypeScript

const response: Promise<FireblocksResponse<ApprovalRequestItem>> = fireblocks.approvalsBeta.getApprovalById(approvalsBetaApiGetApprovalByIdRequest);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/approvals/{requestId}",
  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/{requestId}"

	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/{requestId}")

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

{
  "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",
  "requestSignature": "",
  "quorumStatus": {
    "requestStatus": "PENDING",
    "quorum": {
      "type": "SIMPLE",
      "threshold": 2,
      "currentApprovalCount": 1,
      "status": "PENDING",
      "isMandatoryOwnerApproved": false,
      "members": [
        0,
        1
      ]
    },
    "users": [
      {
        "index": 0,
        "userId": "6073c3d2-9f4b-4c1a-8f7d-2b1e5a9c4d80",
        "status": "APPROVED"
      },
      {
        "index": 1,
        "userId": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "status": "PENDING",
        "isMandatoryOwner": true
      }
    ]
  }
}

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

Path Parameters

requestId

string

required

The approval request ID.

Query Parameters

userId

string

Report userStatus for this user instead of the authenticated user. This selects whose approval state is returned; it does not change which requests can be fetched. Requires an Admin, Non-Signing Admin, Security Admin or Security Auditor role; other roles are rejected with 403.

quorumStatusMode

enum<string>

default:NONE

How much quorum detail to include in quorumStatus. NONE (the default) returns it as null. SUMMARY returns the approval thresholds, current counts and status. FULL adds users and the per-group members indexes identifying who may approve and who already has. Any other value is rejected with 400; the parameter is case-sensitive.

Available options:

NONE,

SUMMARY,

FULL

Response

The requested approval request.

requestPayload

string

required

The pending approval request as a JSON string, exactly as produced by the backend — this is the precise string to sign in order to approve the request (sign it as-is; do not re-serialize). The JSON has the shape { requestId, requestType, requestTimestamp (epoch ms), expiresAt (epoch seconds), requestData }, where requestData is the request-type-specific payload.

Example:

"{\"requestId\":\"ccr-1f2e3d4c\",\"requestType\":\"ADD_USER\",\"requestTimestamp\":1750000000000,\"expiresAt\":1750600000,\"requestData\":{\"type\":\"ADD_USER\",\"creator\":\"user-1f2e3d4c\",\"id\":\"ccr-1f2e3d4c\"}}"

userStatus

enum<string>

required

The authenticated user's approval status for this request.

Available options:

USER_STATUS_NOT_APPLICABLE,

USER_NOT_ELIGIBLE_TO_APPROVE,

USER_NOT_APPROVED,

USER_APPROVED

Example:

"USER_NOT_APPROVED"

requestSignature

string

Signature over the requestPayload. Empty until request signing is implemented.

Example:

""

quorumStatus

object | null

The approval quorum's structure and progress for this request.

null when quorumStatusMode is omitted or NONE. Also null on an otherwise successful response when the quorum cannot be reported faithfully — a multi-tier request in a workspace that does not maintain per-tier approval counts — so absence here does not imply the request has no quorum.

The object may carry additional backend-defined fields beyond those documented.

Show child attributes

TypeScript

const response: Promise<FireblocksResponse<ApprovalRequestItem>> = fireblocks.approvalsBeta.getApprovalById(approvalsBetaApiGetApprovalByIdRequest);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/approvals/{requestId}",
  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/{requestId}"

	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/{requestId}")

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

{
  "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",
  "requestSignature": "",
  "quorumStatus": {
    "requestStatus": "PENDING",
    "quorum": {
      "type": "SIMPLE",
      "threshold": 2,
      "currentApprovalCount": 1,
      "status": "PENDING",
      "isMandatoryOwnerApproved": false,
      "members": [
        0,
        1
      ]
    },
    "users": [
      {
        "index": 0,
        "userId": "6073c3d2-9f4b-4c1a-8f7d-2b1e5a9c4d80",
        "status": "APPROVED"
      },
      {
        "index": 1,
        "userId": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "status": "PENDING",
        "isMandatoryOwner": true
      }
    ]
  }
}

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

Introduction

Errors & Statuses

Data Objects

API Endpoints

Get a single approval request

Path Parameters

Query Parameters

Response