Get Counterparties
curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/counterpartiesimport requests
url = "https://api.copper.co/platform/organizations/{organizationId}/counterparties"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.copper.co/platform/organizations/{organizationId}/counterparties', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.copper.co/platform/organizations/{organizationId}/counterparties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.copper.co/platform/organizations/{organizationId}/counterparties"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.copper.co/platform/organizations/{organizationId}/counterparties")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/organizations/{organizationId}/counterparties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"counterparties": [
{
"counterpartyId": "<string>",
"counterpartyName": "<string>",
"counterpartyType": "standard",
"networkTag": "<string>",
"backgroundImageId": "<string>",
"counterpartyDescription": "<string>",
"extra": {
"exchangeId": "<string>"
},
"imageId": "<string>",
"priority": "<string>",
"tags": [
"featured"
]
}
]
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}Settlements
Retrieve Network participants
Find participant of the Copper Network
GET
/
organizations
/
{organizationId}
/
counterparties
Get Counterparties
curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/counterpartiesimport requests
url = "https://api.copper.co/platform/organizations/{organizationId}/counterparties"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.copper.co/platform/organizations/{organizationId}/counterparties', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.copper.co/platform/organizations/{organizationId}/counterparties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.copper.co/platform/organizations/{organizationId}/counterparties"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.copper.co/platform/organizations/{organizationId}/counterparties")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/organizations/{organizationId}/counterparties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"counterparties": [
{
"counterpartyId": "<string>",
"counterpartyName": "<string>",
"counterpartyType": "standard",
"networkTag": "<string>",
"backgroundImageId": "<string>",
"counterpartyDescription": "<string>",
"extra": {
"exchangeId": "<string>"
},
"imageId": "<string>",
"priority": "<string>",
"tags": [
"featured"
]
}
]
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}To initiate a settlement you need to know the
counterpartyId. You can find it using this API.Path Parameters
Query Parameters
Search string
Offset for pagination
Limit for pagination
Filter by connection status
Filter by counterparty IDs
Counterparty types list. See details
Available options:
standard, clearloop-exchange, agency-desk Include related counterparty IDs
Include connections
Include counterparty details
Response
OK
Counterparties list
Show child attributes
Show child attributes
Was this page helpful?