Skip to main content
GET
/
organizations
/
{organizationId}
/
counterparties
Get Counterparties
curl --request GET \
  --url https://api.copper.co/platform/organizations/{organizationId}/counterparties
{
  "counterparties": [
    {
      "counterpartyId": "<string>",
      "counterpartyName": "<string>",
      "counterpartyType": "standard",
      "networkTag": "<string>",
      "backgroundImageId": "<string>",
      "counterpartyDescription": "<string>",
      "extra": {
        "exchangeId": "<string>"
      },
      "imageId": "<string>",
      "priority": "<string>",
      "tags": [
        "featured"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.copper.co/llms.txt

Use this file to discover all available pages before exploring further.

Find the counterpartyId to initiate a one-way transfer.

Path Parameters

organizationId
string
required

Query Parameters

Search string

offset
string

Offset for pagination

limit
string
default:1000

Limit for pagination

isConnected
boolean

Filter by connection status

counterpartyIds
string[]

Filter by counterparty IDs

counterpartyTypes
enum<string>[]

Counterparty types list. See details

Available options:
standard,
clearloop-exchange,
agency-desk

Include related counterparty IDs

includeConnections
boolean
default:true

Include connections

includeCounterpartyDetails
boolean
default:true

Include counterparty details

Response

OK

counterparties
object[]
required

Counterparties list