Skip to content
Legaldoc.ioLegaldoc.ioLegaldoc.io

Get envelope

GET
/envelope/{envelopeId}
curl --request GET \
  --url https://app.legaldoc.com/api/v2/envelope/example \
  --header 'Authorization: <Authorization>'

Returns an envelope given an ID

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
envelopeId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
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
documentMeta
required
object
signingOrder
required
string
Allowed values: PARALLEL SEQUENTIAL
distributionMethod
required
string
Allowed values: EMAIL NONE
id
required
string
subject
required
string | null
message
required
string | null
timezone
required
string | null
dateFormat
required
string | null
redirectUrl
required
string | null
typedSignatureEnabled
required
boolean
uploadSignatureEnabled
required
boolean
drawSignatureEnabled
required
boolean
allowDictateNextSigner
required
boolean
language
required
string
emailSettings
required
object
recipientSigningRequest
required
boolean
default: true
recipientRemoved
required
boolean
default: true
recipientSigned
required
boolean
default: true
documentPending
required
boolean
default: true
documentCompleted
required
boolean
default: true
documentDeleted
required
boolean
default: true
ownerDocumentCompleted
required
boolean
default: true
ownerRecipientExpired
required
boolean
default: true
ownerDocumentCreated
required
boolean
default: true
emailId
required
string | null
emailReplyTo
required
string | null
envelopeExpirationPeriod
required
Any of:
object
unit
required
string
Allowed values: day week month year
amount
required
integer
>= 1
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
fields
required
Array<object>
object
envelopeId
required
string
envelopeItemId
required
string
type
required
string
Allowed values: SIGNATURE FREE_SIGNATURE INITIALS NAME EMAIL DATE TEXT NUMBER RADIO CHECKBOX DROPDOWN
id
required
number
secondaryId
required
string
recipientId
required
number
page
required
number
positionX
required
positionY
required
width
required
height
required
customText
required
string
inserted
required
boolean
fieldMeta
required
One of:
object
label
string
placeholder
string
required
boolean
readOnly
boolean
fontSize
number
default: 12 >= 8 <= 96
overflow
required
string
default: auto
Allowed values: auto horizontal vertical crop
type
required
string
Allowed values: signature
envelopeItems
required
Array<object>
object
envelopeId
required
string
documentDataId
required
string
id
required
string
title
required
string
order
required
number
directLink
required
object
directTemplateRecipientId
required
number
enabled
required
boolean
id
required
string
token
required
string
team
required
object
id
required
number
url
required
string
user
required
object
id
required
number
name
required
string
email
required
string
Example
{
  "type": "DOCUMENT",
  "status": "DRAFT",
  "source": "DOCUMENT",
  "visibility": "EVERYONE",
  "templateType": "PUBLIC",
  "authOptions": {
    "globalAccessAuth": [
      "ACCOUNT"
    ],
    "globalActionAuth": [
      "ACCOUNT"
    ]
  },
  "documentMeta": {
    "signingOrder": "PARALLEL",
    "distributionMethod": "EMAIL",
    "emailSettings": {
      "recipientSigningRequest": true,
      "recipientRemoved": true,
      "recipientSigned": true,
      "documentPending": true,
      "documentCompleted": true,
      "documentDeleted": true,
      "ownerDocumentCompleted": true,
      "ownerRecipientExpired": true,
      "ownerDocumentCreated": true
    },
    "envelopeExpirationPeriod": {
      "unit": "day"
    }
  },
  "recipients": [
    {
      "role": "CC",
      "readStatus": "NOT_OPENED",
      "signingStatus": "NOT_SIGNED",
      "sendStatus": "NOT_SENT",
      "authOptions": {
        "accessAuth": [
          "ACCOUNT"
        ],
        "actionAuth": [
          "ACCOUNT"
        ]
      }
    }
  ],
  "fields": [
    {
      "type": "SIGNATURE",
      "fieldMeta": {
        "fontSize": 12,
        "overflow": "auto",
        "type": "signature"
      }
    }
  ]
}

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"
    }
  ]
}