Compliance

List counterparty groups

Returns a paginated list of counterparty groups.

Endpoint Permissions: Admin, Non-Signing Admin, Viewer.

get/counterparty_groups

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/counterparty_groups/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageCursorstring

Cursor of the required page

pageSizeinteger

Maximum number of items in the page

Response

A paginated list of counterparty groups

totalinteger

Total number of counterparty groups

nextstring

Cursor for the next page

Example response

{
  "data": [
    {
      "groupId": "44fcead0-7053-4831-a53a-df7fb90d440f",
      "name": "APAC Financial Partners",
      "description": "Group for all APAC-based financial institution counterparties",
      "jurisdictionCodes": [
        "US",
        "SG"
      ],
      "isActive": true,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 42,
  "next": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"
}

Changes

No recorded changes to this operation across all 1 revision of this API.