Sign in
latestOpenAPI 3.0.32026-08-04890635.7 KB

3db245102197

Envelope

Get envelope

Returns an envelope given an ID

get/envelope/{envelopeId}

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