Skip to content
WorkRoad home
REST API

Restore a note folder from the trash

POST
/note-folders/{folderId}/restore

Brings a trashed folder back with the notes that went to the trash with it, and returns the folder. Needs notes:delete, the scope that trashed it. If a live folder took its name meanwhile, the restored folder is renamed name (2), name (3) and so on. Notes trashed on their own before the folder stay in the trash.

Required scopes: notes:delete

Authorization

headerAuthorizationBearer <token>

Path Parameters

folderId*string

Note folder id, scoped to the key's user.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

Idempotency-Key?string

A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.

Match^[\x21-\x7E]{1,255}$
Length1 <= length <= 255

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://workroad.app/api/v1/note-folders/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",    "name": "Biology",    "subjectId": null,    "icon": "Folder"  }}

List note folders GET

Every folder owned by the key's user, sorted by name, then id.

Update a note folder PATCH

Changes only the fields you send; null on subjectId unfiles the folder.