Skip to content
Legaldoc.ioLegaldoc.ioLegaldoc.io

Find envelopes

GET
/envelope
curl --request GET \
  --url 'https://app.legaldoc.com/api/v2/envelope?type=DOCUMENT&source=DOCUMENT&status=DRAFT&hasExpiredRecipients=true&orderByColumn=createdAt&orderByDirection=asc' \
  --header 'Authorization: <Authorization>'

Find envelopes based on search criteria

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
query
string

The search query.

page
number
>= 1

The pagination page number, starts at 1.

perPage
number
>= 1 <= 100

The number of items per page.

type
string
Allowed values: DOCUMENT TEMPLATE

Filter envelopes by type (DOCUMENT or TEMPLATE).

templateId
number

Filter envelopes by the template ID used to create it.

source
string
Allowed values: DOCUMENT TEMPLATE TEMPLATE_DIRECT_LINK

Filter envelopes by how it was created.

status
string
Allowed values: DRAFT PENDING COMPLETED REJECTED CANCELLED

Filter envelopes by the current status.

hasExpiredRecipients
string
Allowed values: true false

Filter for envelopes that have at least one recipient whose signing link has expired.

folderId
string

Filter envelopes by folder ID.

orderByColumn
string
Allowed values: createdAt
orderByDirection
string
default: desc
Allowed values: asc desc

Sort direction.

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
data
required
Array<object>
object
internalVersion
required
number
type
required
string
Allowed values: DOCUMENT TEMPLATE
status
required
string
Allowed values: DRAFT PENDING COMPLETED REJECTED CANCELLED
source
required
string
Allowed values: DOCUMENT TEMPLATE TEMPLATE_DIRECT_LINK
visibility
required
string
Allowed values: EVERYONE MANAGER_AND_ABOVE ADMIN
templateType
required
string
Allowed values: PUBLIC PRIVATE ORGANISATION
id
required
string
secondaryId
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string
completedAt
required
string | null
deletedAt
required
string | null
title
required
string
authOptions
required
object
globalAccessAuth
required
Array<string>
Allowed values: ACCOUNT TWO_FACTOR_AUTH
globalActionAuth
required
Array<string>
Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD
formValues
required
object | null
publicTitle
required
string
publicDescription
required
string
userId
required
number
teamId
required
number
folderId
required
string | null
templateId
required
number | null
user
required
object
id
required
number
name
required
string
email
required
string
recipients
required
Array<object>
object
envelopeId
required
string
role
required
string
Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT
readStatus
required
string
Allowed values: NOT_OPENED OPENED
signingStatus
required
string
Allowed values: NOT_SIGNED SIGNED REJECTED
sendStatus
required
string
Allowed values: NOT_SENT SENT
id
required
number
email
required
string
name
required
string
token
required
string
documentDeletedAt
required
string | null
expired
required
string | null
expiresAt
required
string | null
expirationNotifiedAt
required
string | null
signedAt
required
string | null
authOptions
required
object
accessAuth
required
Array<string>
Allowed values: ACCOUNT TWO_FACTOR_AUTH
actionAuth
required
Array<string>
Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE
signingOrder
required
number | null
rejectionReason
required
string | null
team
required
object
id
required
number
url
required
string
count
required
number
currentPage
required
number
perPage
required
number
totalPages
required
number
Example
{
  "data": [
    {
      "type": "DOCUMENT",
      "status": "DRAFT",
      "source": "DOCUMENT",
      "visibility": "EVERYONE",
      "templateType": "PUBLIC",
      "authOptions": {
        "globalAccessAuth": [
          "ACCOUNT"
        ],
        "globalActionAuth": [
          "ACCOUNT"
        ]
      },
      "recipients": [
        {
          "role": "CC",
          "readStatus": "NOT_OPENED",
          "signingStatus": "NOT_SIGNED",
          "sendStatus": "NOT_SENT",
          "authOptions": {
            "accessAuth": [
              "ACCOUNT"
            ],
            "actionAuth": [
              "ACCOUNT"
            ]
          }
        }
      ]
    }
  ]
}

400

Section titled “400”

Invalid input data

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Section titled “401”

Authorization not provided

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Section titled “403”

Insufficient access

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

404

Section titled “404”

Not found

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}