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.
| Endpoint | Summary |
|---|---|
| get/ | Get workspace status |
| Endpoint | Summary |
|---|---|
| get/ | List ledger entries |
| get/ | Verify the ledger |
| Endpoint | Summary |
|---|---|
| get/ | List invoices |
| post/ | Add an invoice |
| Endpoint | Summary |
|---|---|
| get/ | List counterparties |
| get/ | Get a counterparty |
| post/ | Add a counterparty |
| post/ | Create a payee link |
| Endpoint | Summary |
|---|---|
| get/ | List milestones |
| post/ | Add a milestone |
| Endpoint | Summary |
|---|---|
| get/ | Get the treasury |
| Endpoint | Summary |
|---|---|
| get/ | Get insights |