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

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

Query Parameters

pagination
object

Response

List of counterparties

counterparties
object[]
meta
object