List counterparties

Returns counterparties ordered by name, then id.

GET /counterparties

List counterparties

cURL

curl --request GET \
  --url https://api.thinkout.io/v1/counterparties \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "list",
  "data": [
    {
      "object": "counterparty",
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "name": "Orange",
      "country_code": "RO",
      "color": "#e4571b",
      "symbol": "OR",
      "created_at": "2024-02-14T08:00:00Z",
      "updated_at": "2024-02-14T08:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Query Parameters

limit · integer · default: 100

Page size.

Required range: 1 <= x <= 500

cursor · string

Opaque token from the previous page's next_cursor.

Response

200

application/json

A page of counterparties.

object · string · required

Allowed value: "list"

data · object[] · required

Show child attributes

has_more · boolean · required

Whether another page exists.

next_cursor · string | null · required

Pass as cursor to fetch the next page. null on the last page.