Skip to content
VestiarionDocs

API reference

Endpoint overview

Every v1 endpoint, what it answers, and the conventions they share.

Every v1 endpoint is under https://www.vestiarion.xyz/api/v1, authenticated with a workspace API key sent as Authorization: Bearer <key>, and reaches only that key's workspace. A GET reads. A POST adds a counterparty, an invoice or a milestone, or makes a payee link, with a key that has write access, and answers 201 with the record: shaped as its list returns it, or for a payee link, the link. A response carries its result in data: one object, or for a collection an array, beside page with nextCursor, hasMore and count for paging. A failure answers { "error": { "code", "message" } } with one of the error codes. The same endpoints are published as an OpenAPI 3.1 document. In TypeScript, the TypeScript SDK gives each one a typed method.

Workspace
EndpointSummary
get/api/v1/statusGet workspace status
Ledger
EndpointSummary
get/api/v1/ledgerList ledger entries
get/api/v1/ledger/verifyVerify the ledger
Payables and receivables
EndpointSummary
get/api/v1/invoicesList invoices
post/api/v1/invoicesAdd an invoice
Counterparties
EndpointSummary
get/api/v1/counterpartiesList counterparties
get/api/v1/counterparties/{id}Get a counterparty
post/api/v1/counterpartiesAdd a counterparty
post/api/v1/payee-linksCreate a payee link
Milestones
EndpointSummary
get/api/v1/milestonesList milestones
post/api/v1/milestonesAdd a milestone
Treasury
EndpointSummary
get/api/v1/treasuryGet the treasury
Insights
EndpointSummary
get/api/v1/insightsGet insights