SPsparkvault
vaults

List a vault's folders, or find one by path

Changed on

One page of the vault's folders, at most limit of them, in an order that holds from page to page and is not by name: follow next_page_token until it is null. A page can hold fewer folders, or none, without being the last. Sort by name on the client, over the folders it holds. To show one folder's subfolders, list its contents (GET /vaults/{id}/contents), which pages them first, rather than the vault's folders. With path, only the folder at that path, never paged: the same folders list holding that one folder, or no folder when a segment names none (an empty list, not a 404). The path is written and validated as an upload's folder_path is, and read from the vault root one segment at a time: each segment is the folder that holds that name, in any case and in either Unicode form, under the folder before it. A folder being deleted is in neither answer.

get/vaults/{id}/folders

Request

Path parameters

idstring required

The vault.

Query parameters

limitinteger

A page-size hint: a value above 500 reads as 500, and a missing, zero, negative or non-numeric one as 100.

page_tokenstring

The next_page_token a previous page returned, sent with the same include_system. Opaque; it opens only for that vault's folder list, for the account it was issued to. Refused with path.

pathstring

Answer only the folder at this path: slash-delimited from the vault root (e.g. Clients/Acme), in the syntax and with the validation of an upload's folder_path, each name matched in any case and in either Unicode form. A comma is part of a name (Smith, John); a path sent twice reads as its values joined with a comma. Omitted: one page of the vault's folders.

include_systemstring

true includes system folders, in the list and as segments of a path; any other value, or none, leaves them out.

Response

One page of the folders; with path, the folder at that path or none.

Changes

  • a9a10e328ba5Revision 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

      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

      added the required property / to the response with the status

  • 56d7c265a77aRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status