---
title: "List counterparties"
method: GET
path: "/v1/counterparties"
tags: ["Counterparties"]
---

# List counterparties

`GET /v1/counterparties`

Lists counterparties for the authenticated organization.

## Query parameters

- `page` integer — Page number (1-based).
- `pageSize` integer — Items per page (max 100).
- `includeArchived` boolean — Include archived counterparties in results.

## Headers

- `x-project-id` string — Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

## Response `200`

Counterparties list

- object — Standard success response envelope.
  - `data` object, required — Paginated list of counterparties.
    - `counterparties` object[], required — Counterparties.
      - `id` string, required — Counterparty identifier.
      - `organizationId` string, required — Organization identifier.
      - `projectId` string, nullable, required — Project scope when the counterparty is project-scoped.
      - `externalId` string, nullable, required — Caller-supplied opaque identifier for cross-system reference. Do not place personal data in this indexed field.
      - `entityType` 'individual' | 'business', required — Counterparty entity type.
      - `displayName` string, required — Human-readable, searchable display name. Keep it minimal because this indexed field is not application-encrypted.
      - `status` 'active' | 'archived', required — Counterparty status.
      - `createdBy` string, nullable, required — User who created the counterparty. Null when created via API key.
      - `createdAt` string, date-time, required — Creation timestamp.
      - `updatedAt` string, date-time, required — Last update timestamp.
    - `total` integer, required — Total counterparties matching the query.
    - `page` integer, required — Current page number.
    - `pageSize` integer, required — Items per page.
  - `meta` object, required — Response metadata.
    - `requestId` string, required — Request identifier for tracing.
    - `timestamp` string, date-time, required — ISO 8601 timestamp.

## Other responses

- `400` — Error
- `401` — Error
- `403` — Error
- `500` — Error

---

[API](https://skmtc.dev/solana/apis/solana-developer-platform-api.md) · [All operations](https://skmtc.dev/solana/apis/solana-developer-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/solana/solana-developer-platform-api/revisions/13f3098243d6/schema)
