---
title: "Get Counterparties"
method: GET
path: "/organizations/{organizationId}/counterparties"
tags: ["network"]
---

# Get Counterparties

`GET /organizations/{organizationId}/counterparties`

## Request

- Base URL: `https://api.copper.co/platform`
- URL: `https://api.copper.co/platform/organizations/{organizationId}/counterparties`
- Auth: none declared
- TypeScript: <https://skmtc.dev/copper-co/apis/copper-platform-api/docs/organizations/:organizationId/counterparties/get.ts> (a function with typed inputs; its response is checked against the schema)

Find participant of the Copper Network

## Path parameters

- `organizationId` string, required

## Query parameters

- `search` string
- `offset` string
- `limit` string
- `isConnected` boolean
- `counterpartyIds` string[]
- `counterpartyTypes` CounterpartyType[]
- `includeRelatedCounterpartyIds` boolean
- `includeConnections` boolean
- `includeCounterpartyDetails` boolean

## Response `200`

OK

- Counterparties
  - `counterparties` Counterparty[], required: Counterparties list
    - `backgroundImageId` string: Background image id
    - `counterpartyDescription` string: Counterparty description
    - `counterpartyId` string, required: Counterparty ID
    - `counterpartyName` string, required: Counterparty name
    - `counterpartyType` 'standard' | 'clearloop-exchange' | 'agency-desk', required
    - `extra` CounterpartyExtra
      - `exchangeId` string: Counterparty exchange id
    - `imageId` string: Image id
    - `networkTag` string, required: Counterparty network handle
    - `priority` string: Counterparty priority indicator. The higher the value, the higher the priority
    - `tags` CounterpartyTag[]: Counterparty tags. [See details](/enums/CounterpartyTag)

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `409`: Conflict

---

[API](https://skmtc.dev/copper-co/apis/copper-platform-api.md) - [All operations](https://skmtc.dev/copper-co/apis/copper-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/copper-co/apis/copper-platform-api/revisions/44296120fc7d?raw)