Skip to main content
GET
/
v1
/
counterparties
/
{id}
Get counterparty by ID
curl --request GET \
  --url https://api.nomi.tools/v1/counterparties/{id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "name": "<string>",
  "externalId": "<string>",
  "balance": 123,
  "notes": "<string>",
  "isArchived": true,
  "types": [
    "client"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nomi.tools/llms.txt

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

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication. Provide your email as login and PPT token as the password.

Headers

​
Accept
enum<string>
default:application/json
required
Available options:
application/json

Path Parameters

​
id
string
required

Response

Counterparty details

​
id
string

Unique identifier for the counterparty.

​
name
string

Name of the counterparty.

​
externalId
string | null

External identifier for the counterparty.

​
balance
number<float>

Current balance of the counterparty.

​
notes
string | null

Additional notes about the counterparty.

​
isArchived
boolean

Indicates if the counterparty is archived.

​
types
enum<string>[]

Types associated with the counterparty.

Available options:
client,
supplier,
partner,
contractor,
other