CounterpartiesList counterparties

List counterparties

Vault counterparties (by createdAt desc, keyset pagination) with address and operation counts. Only active ones by default.

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/counterparties?search=example_string&kind=exchange&address=123%20Main%20St&groupId=example_string&archived=true&limit=42&cursor=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "items": [
    {
      "id": "cmr3f41z20001psp7phmyapw3",
      "vaultId": "example_string",
      "name": "Binance",
      "description": "example_string",
      "kind": "exchange",
      "tagsJson": [
        "example_string"
      ],
      "avatarUri": "example_string",
      "color": "#000",
      "emoji": "🏦",
      "archivedAt": "2026-07-02T11:25:15.134000Z",
      "createdById": "example_string",
      "createdAt": "2026-07-02T11:25:15.134000Z",
      "updatedAt": "2026-07-02T11:25:15.134000Z",
      "addresses": [
        {
          "id": "example_string",
          "network": "tron",
          "address": "TExternalBinanceHot1",
          "label": "hot wallet"
        }
      ],
      "_count": {
        "addresses": 42,
        "transactions": 42,
        "incomingTransactions": 42
      }
    }
  ],
  "nextCursor": "example_string"
}
GET
/api/v1/vaults/{code}/counterparties
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

path
codestring
Required

Unique Vault code (slug)

query
addressstring

Exact on-chain address, to find the owning counterparty (reverse lookup for the send UI)

query
groupIdstring

Only members of the counterparty group ("folders" in the UI)

query
archivedstring

true means only archived ones (default: only active)

Options: true, false
query
limitinteger
Min: 1 • Max: 100
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

codestring
Required

Unique Vault code (slug)

Example:
demo_vault

Query Parameters

kindstring
Example:
exchange
addressstring

Exact on-chain address, to find the owning counterparty (reverse lookup for the send UI)

groupIdstring

Only members of the counterparty group ("folders" in the UI)

archivedstring

true means only archived ones (default: only active)

Allowed values:truefalse

Responses

itemsarray
Required
nextCursorstring
Required