---
title: "List counterparties"
method: GET
path: "/api/v1/counterparties"
tags: ["Counterparties"]
---

# List counterparties

`GET /api/v1/counterparties`

## Request

- Base URL: `https://www.vestiarion.xyz`
- URL: `https://www.vestiarion.xyz/api/v1/counterparties`
- Auth: HTTP bearer

Vendors, clients and contractors, newest first, with the row id breaking equal timestamps. Both the business's baseline payment limit and the current limit derived from the risk tier are reported. `performanceScore` is `null` when there is no history.

## Query parameters

- `limit` integer
- `cursor` string
- `role` 'vendor' | 'client' | 'contractor'
- `riskLevel` 'unscreened' | 'clear' | 'medium' | 'high'

## Response `200`

OK

- ListCounterpartiesResponse
  - `data` object[], required
    - `id` string, required
    - `name` string, required
    - `role` 'vendor' | 'client' | 'contractor', required
    - `address` string, nullable, required
    - `chain` string, nullable, required
    - `jurisdiction` string, nullable, required
    - `riskLevel` 'unscreened' | 'clear' | 'medium' | 'high', required
    - `riskNotes` string, nullable, required
    - `baselinePaymentLimit` number, nullable, required: The business's baseline payment limit for this counterparty.
    - `paymentLimit` number, nullable, required: The current payment limit, derived from the risk tier.
    - `lastScreenedAt` string, nullable, required
    - `performanceScore` number, nullable, required: No history is different from a zero score and remains null.
    - `performanceInputs` object, nullable, required
    - `createdAt` string, required
  - `page` object, required: Where this page sits in the collection.
    - `nextCursor` string, nullable, required: Pass back as `?cursor=` to continue. Null when the end is reached.
    - `hasMore` boolean, required: Whether another page follows this one.
    - `count` integer, required: How many items this response carries.

## Other responses

- `400`: invalid_request
- `401`: unauthorized
- `403`: forbidden
- `500`: internal

---

[API](https://skmtc.dev/vestiarion/apis/vestiarion-api.md) · [All operations](https://skmtc.dev/vestiarion/apis/vestiarion-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vestiarion/apis/vestiarion-api/revisions/fd2f589dac9b?raw)
