Skip to content
Subnoto Logo Subnoto Documentation

list

POST
/public/envelope/list

List all envelopes in a workspace.

Request Body

Section titled “Request Body ”
object
workspaceUuid

The UUID of the workspace to list the envelopes in.

string
>= 36 characters <= 36 characters
tags

Optional array of tag names to filter envelopes by

Array<string>
0
page

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

integer
default: 1 >= 1 <= 9007199254740991

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
envelopes
required
Array<object>
object
uuid
required

The unique identifier of the envelope.

string
title
required

The title of the envelope.

string
<= 255 characters
creationDate
required

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

number
updateDate
required

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

number
sentDate
required
Any of:
number
status
required

The status of the envelope.

string
Allowed values: uploading draft approving signing complete declined canceled
workspaceUuid
required

The UUID of the workspace the envelope belongs to.

string
owner
required

The creator of the envelope.

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
metrics
required

The metrics of the envelope.

object
signatureCount
required

The number of signatures on the envelope.

number
signatureRequiredCount
required

The number of signatures required on the envelope.

number
approvalCount
required

The number of approvals on the envelope.

number
approvalRequiredCount
required

The number of approvals required on the envelope.

number
tags
required

The tags of the envelope.

Array<string>
0

401

Section titled “401 ”

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

403

Section titled “403 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN 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

500

Section titled “500 ”

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