---
title: "List integrations"
method: GET
path: "/v1/integrations"
tags: ["Integrations"]
---

# List integrations

`GET /v1/integrations`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/integrations`
- Auth: API key in header `x-api-key`

Returns the authenticated member catalog or the elevated integration management projection based on the caller role.

## Query parameters

- `pageSize` integer: Requested number of resources to return. Oversized values are clamped to the route limit.
- `pageToken` string: Opaque token returned by the previous list response.
- `integrationRef` string: Filter by public integration reference
- `chainId` string: Filter by linked chain ID
- `type` 'BLOCKCHAIN' | 'EXCHANGE' | 'BANK': Filter by integration type
- `status` 'ACTIVE' | 'ALPHA' | 'BETA' | 'DISABLED': Filter by integration status
- `mode` 'API' | 'FILE_UPLOAD': Filter by integration mode
- `isEvm` boolean: Filter by EVM compatibility
- `name` string: Filter by integration name
- `search` string: Search integration name, description, or ID

## Response `200`

- union
  - IntegrationsListResponseDto
    - `data` IntegrationResponseDto[], required
      - `integrationRef` string, required: Public integration reference
      - `priority` integer, required: Integration display priority
      - `name` string, required: Integration name
      - `logoUrl` string, nullable, required: Integration logo URL
      - `description` string, required: Integration description
      - `type` 'BLOCKCHAIN' | 'EXCHANGE' | 'BANK', required: Integration type
      - `chainId` string, nullable, required: Linked chain ID
      - `chain` object, nullable, required: Linked chain testnet classification
        - `isTestnet` boolean, required
      - `exchangeRequiredCredentials` string, nullable, required: Required exchange credential metadata
      - `status` 'ACTIVE' | 'ALPHA' | 'BETA' | 'DISABLED', required: Integration status
      - `isEvm` boolean, required: Whether the integration is EVM-compatible
      - `mode` 'API' | 'FILE_UPLOAD', required: Integration mode
      - `processor` string, nullable, required: Integration processor key
      - `walletsCount` integer, required: Number of wallets using the linked chain
      - `createdAt` string, date-time, required: Creation timestamp (ISO 8601)
      - `updatedAt` string, date-time, required: Last update timestamp (ISO 8601)
    - `pagination` object, required
      - `pageSize` integer, required: Items returned per page.
      - `nextPageToken` string: Opaque token for retrieving the next page.
  - UserIntegrationCatalogListResponseDto
    - `data` UserIntegrationCatalogItemDto[], required
      - `integrationRef` string, required: Public integration reference
      - `priority` integer, required: Integration display priority
      - `name` string, required: Integration name
      - `logoUrl` string, nullable, required: Integration logo URL
      - `description` string, required: Integration description
      - `type` 'BLOCKCHAIN' | 'EXCHANGE' | 'BANK', required: Integration type
      - `chainId` string, nullable, required: Linked chain ID
      - `chain` object, nullable, required: Linked chain testnet classification
        - `isTestnet` boolean, required
      - `exchangeRequiredCredentials` string, nullable, required: Required exchange credential metadata
      - `status` 'ACTIVE' | 'ALPHA' | 'BETA' | 'DISABLED', required: Integration status
      - `isEvm` boolean, required: Whether the integration is EVM-compatible
      - `mode` 'API' | 'FILE_UPLOAD', required: Integration mode
      - `processor` string, nullable, required: Integration processor key
    - `pagination` object, required
      - `pageSize` integer, required: Items returned per page.
      - `nextPageToken` string: Opaque token for retrieving the next page.

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)
