DOdocumenso
Envelope

Get envelope

Changed on

Returns an envelope given an ID

get/envelope/{envelopeId}

Request

  • Base URL
    https://app.documenso.com/api/v2
  • Auth
    API key in header Authorization

Path parameters

envelopeIdstring required

Response

Successful response

internalVersionnumber required
type'DOCUMENT' | 'TEMPLATE' required
status'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED' required
source'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK' required
visibility'EVERYONE' | 'MANAGER_AND_ABOVE' | 'ADMIN' required
templateType'PUBLIC' | 'PRIVATE' | 'ORGANISATION' required
idstring required
secondaryIdstring required
externalIdstring nullable required
createdAtstring required
updatedAtstring required
completedAtstring nullable required
deletedAtstring nullable required
titlestring required
formValuesobject nullable required
publicTitlestring required
publicDescriptionstring required
userIdnumber required
teamIdnumber required
folderIdstring nullable required
templateIdnumber nullable required

Changes

  • d1369b2bf296Revision changes
    • info

      added the optional property //// to the response with the status