List a vault's ingots
Changed onA page of the vault's ingots, in the vault index's order. sort_by orders only the ingots of the page it answers, never the list across pages: for one order across the vault, search (GET /vaults/{id}/ingots/search) or list a folder's contents (GET /vaults/{id}/contents). Page with cursor until has_more is false.
Request
- Base URLhttps://api.sparkvault.com/v1
- Auth
- API key in header X-API-Key and API key in header X-Vault-Access-Token
- or HTTP bearer and API key in header X-Vault-Access-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The vault.
Query parameters
A page-size hint: a value above 200 reads as 200, and a missing, zero, negative or non-numeric one as 100.
The next_cursor a previous page returned. Opaque, and sealed to the query that issued it.
Orders the page's ingots, and only that page's. Omitted: the vault index's order.
Response
A page of ingots.
Changes
- info
added the new optional
queryrequest parametercursor - info
added the new optional
queryrequest parameterlimit - info
added the new optional
queryrequest parametersort_by - info
added the new optional
queryrequest parametersort_order - info
added the non-success response with the status
- info
added the success response with the status
- info