Get a counterparty

GET /counterparties/{id}

Get a counterparty

cURL

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

200

{
  "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"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> · required

Response

200

application/json

The counterparty.

object · string · required

Allowed value: "counterparty"

id · string<uuid> · required

name · string · required

Example:

"Orange"

country_code · string | null · required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

Example:

"RO"

color · string | null · required

Pattern: ^#[0-9a-f]{6}$

symbol · string | null · required

Short text shown in the counterparty avatar in ThinkOut.

created_at · string<date-time> · required

updated_at · string<date-time> · required