Templates

List templates in the workspace

get/v1/templates

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/templates
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer
    • HTTP bearer

Query parameters

status'active' | 'archived' | 'all'
Example:active

Filter templates by status

kind'reusable' | 'oneoff'
Example:reusable

Which kind of template to list. reusable (the default) is the templates library. oneoff returns only the single-use templates behind an unfinished 'upload and send' — the ones still being prepared, with no document created from them yet.

Response

idstring uuid required
workspaceIdstring uuid required
ownerIdstring required

Clerk user ID of the owner

namestring required
kind'reusable' | 'oneoff' required

Reusable templates appear in the templates list. One-off templates back a single 'upload and send' document and are hidden from every listing.

archivedAtinteger

Unix ms when archived (null if active)

createdAtinteger required
updatedAtinteger required
currentDraftVersionIdstring uuid nullable
currentPublishedVersionIdstring uuid nullable

Changes

No recorded changes to this operation across all 1 revision of this API.