SignEnvoy docs
Sign in Start in the sandbox

API reference Folders

API reference

Folders

GET /v1/folders

List Folders

Query

  • kind "documents" | "templates" default "documents". Which tree to list: `documents` (the default) or `templates`.

Responses

  • 200 array of FolderOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/folders

Create Folder

Request body (application/json, required)

MemberTypeNotes
kind "documents" | "templates" `documents` (the default) or `templates`. The parent, if any, must be a folder of the same kind. Default "documents".
name required string (min length 1, max length 120)
parent_id string (uuid) | null

Responses

  • 201 FolderOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

PATCH /v1/folders/{folder_id}

Patch Folder

Path

  • folder_id string (uuid)

Request body (application/json, required)

MemberTypeNotes
move_to_root boolean Default false.
name string (min length 1, max length 120) | null
parent_id string (uuid) | null

Responses

  • 200 FolderOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

DELETE /v1/folders/{folder_id}

Delete Folder

Path

  • folder_id string (uuid)

Responses

  • 204 no body: Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.