List a folder's contents
Changed onOne page of a folder's children, or of the vault root's when folder_id is omitted. The children are one sequence across pages: every subfolder first, in an order that holds from page to page and is not by name, then the ingots in creation order, newest first unless sort_order is asc. A page holds at most limit children, so one page can hold the last subfolders and the first ingots, and it can hold fewer, or none, without being the last: follow next_page_token until it is null. Every page carries the folder and its breadcrumb. Sort by name, size or type on the client, over the children it holds. A file moved into the folder while you page appears on a later page only when it was created before the ingots already listed (after them under asc); one moved out before its page is read does not appear; no child appears twice.
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
The folder to list. Omitted: the vault root.
A page-size hint: a value above 500 reads as 500, and a missing, zero, negative or non-numeric one as 100.
The next_page_token a previous page returned, sent with the same folder_id, sort_order and include_system. Opaque; it opens only for that listing of that vault, for the account it was issued to.
The ingots' creation order.
Only created, the one order the listing reads; any other value is refused.
true lists the vault's protected system folders and ingots too.
Response
One page of the folder's children.
Changes
- info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
added the required property
/to the response with the status - info
added the required property
/to the response with the status
- info
- breaking
the response property
/became nullable for the status - breaking
the response property
/became nullable for the status
- breaking