Skip to main content
GET
/
counterparty_groups
TypeScript
const response: Promise<FireblocksResponse<CounterpartyGroupsPaginatedResponse>> = fireblocks.compliance.listCounterpartyGroups(complianceApiListCounterpartyGroupsRequest);
CompletableFuture<ApiResponse<CounterpartyGroupsPaginatedResponse>> response = fireblocks.compliance().listCounterpartyGroups(pageCursor, pageSize);
response = fireblocks.compliance.list_counterparty_groups(page_cursor, page_size);
curl --request GET \
  --url https://api.fireblocks.io/v1/counterparty_groups
const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/counterparty_groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

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

	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/counterparty_groups")

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": [
    {
      "groupId": "44fcead0-7053-4831-a53a-df7fb90d440f",
      "name": "APAC Financial Partners",
      "isActive": true,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "description": "Group for all APAC-based financial institution counterparties",
      "jurisdictionCodes": [
        "US",
        "SG"
      ]
    }
  ],
  "total": 42,
  "next": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"
}
{
  "message": "<string>",
  "code": 123
}

Query Parameters

​
pageCursor
string

Cursor of the required page

​
pageSize
integer
default:50

Maximum number of items in the page

Required range: 1 <= x <= 100

Response

A paginated list of counterparty groups

Paginated list of counterparty groups

​
data
object[]
required

The counterparty groups in the current page

​
total
integer

Total number of counterparty groups

Example:

42

​
next
string

Cursor for the next page

Example:

"eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"