Skip to content

list

POST
/public/template/list

List all templates accessible by the team.

object
workspaceUuid

The UUID of the workspace to list the templates in.

string
>= 36 characters <= 36 characters
page

The page number to retrieve (1-indexed). Defaults to 1. Each page contains up to 50 results.

integer
default: 1 >= 1 <= 9007199254740991

Default Response

object
templates
required
Array<object>
object
uuid
required

The unique identifier of the template.

string
title
required

The title of the template.

string
<= 255 characters
creationDate
required

The date and time the template was created (unix timestamp).

number
updateDate
required

The date and time the template was last updated (unix timestamp).

number
status
required

The status of the template.

string
Allowed values: incomplete draft active archived
workspaceUuid
required

The UUID of the workspace the template belongs to.

string
owner
required

The creator of the template.

object
uuid
required

The unique identifier of the owner.

string
email
required

The email of the owner.

string
firstname
required
Any of:
string
lastname
required
Any of:
string
documents
required
Array<object>
object
uuid
required

The unique identifier of the document.

string
title
required

The title of the document.

string
<= 255 characters
tags
required

The tags of the template.

Array<string>
0
recipients
required

The recipients of the template.

Array<object>
object
label
required

The label of the recipient.

string
recipientCount
required

The number of recipients in the template.

number

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHORIZATION_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string