Skip to main content

Folders

Add a folder to your vault

POST /object/folder

Add a folder to your safe.

Parameters: No parameters

Request body:

{
"name": "Folder Name"
}

Request URL examples:

  • https://domain.com

Edit a folder in your vault

PUT /object/folder/{id}

Edit an existing folder in your safe by specifying the unique folder identifier in the path and the new folder "name": in the request body.

Parameters:

  • Id - Unique identifier of the item to edit.

Request body:

{
"name": "Folder Name"
}

Request URL examples:

  • https://domain.com

Retrieve a folder from your vault

GET /object/folder/{id}

Retrieve an existing folder from your safe by specifying the unique folder identifier in the path.

Parameters:

  • Id - Unique identifier of the item to retrieve.

Request URL examples:

  • https://domain.com

Delete a folder from your vault

DELETE /object/folder/{id}

Delete an existing folder from your safe by specifying the unique folder identifier in the path.

Deleting a folder will not delete the items in it.

Parameters:

  • Id - Unique identifier of the item to delete.

Request URL examples:

  • https://domain.com

Retrieve a list of folders in your vault

GET /list/object/folders

Retrieve a list of folders in your safe. By default, this will return a list of all folders, however you can specify search terms as query parameters to narrow list results.

Parameters:

  • search - List all folders that contain this search term.

Request URL examples:

  • https://domain.com