Counterparties

List counterparties

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.

get/api/v1/counterparties

Request

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

Query parameters

limitinteger

How many items to return. Defaults to 50; a larger value is capped at 200.

cursorstring

The previous response's page.nextCursor, passed back unchanged to continue. Opaque: never decode or construct one. A cursor this endpoint could not have issued is refused with 400.

role'vendor' | 'client' | 'contractor'

Only counterparties with this role.

riskLevel'unscreened' | 'clear' | 'medium' | 'high'

Only counterparties at this risk tier.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.