Api reference
Get envelope detail
Returns the full envelope detail resource with recipients, documents, fields, and audit trail. Internal storage keys are never exposed.
GET
/workspaces/{workspaceId}/envelopes/{envelopeId}Authorization
bearer AuthorizationBearer <token>
In: header
Response Body
application/json
curl -X GET "https://loading/workspaces/{workspaceId}/envelopes/{envelopeId}"{
"success": true,
"statusCode": 100,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"path": "string",
"responseTime": "string",
"meta": {
"currentPage": 1,
"totalPages": 1,
"totalItems": 0,
"itemsPerPage": 1
},
"data": {
"id": "string",
"workspaceId": "string",
"templateId": "string",
"title": "string",
"message": "string",
"status": "DRAFT",
"externalId": "string",
"pageCount": 0,
"expiresAt": "2019-08-24T14:15:22Z",
"sentAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"voidedAt": "2019-08-24T14:15:22Z",
"voidReason": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"canReopenForEdit": true,
"reopenBlockedReason": "NONE",
"hasSigningActivity": true,
"workspace": {
"id": "string"
},
"template": {
"id": "string",
"title": "string"
},
"recipients": [
{
"id": "string",
"name": "string",
"email": "user@example.com",
"role": "SIGNER",
"order": 1,
"status": "PENDING",
"invitedAt": "2019-08-24T14:15:22Z",
"viewedAt": "2019-08-24T14:15:22Z",
"signedAt": "2019-08-24T14:15:22Z",
"declinedAt": "2019-08-24T14:15:22Z",
"declineReason": "string",
"fieldValues": [
{
"id": "string",
"fieldId": "string",
"value": "string",
"submittedAt": "2019-08-24T14:15:22Z"
}
]
}
],
"documents": [
{
"id": "string",
"uploadId": "string",
"fileName": "string",
"order": 1,
"pageCount": 1,
"startPage": 1,
"endPage": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"fields": [
{
"id": "string",
"recipientId": "string",
"templateFieldId": "string",
"type": "SIGNATURE",
"page": 1,
"posX": 0,
"posY": 0,
"width": 0,
"height": 0,
"label": "string",
"placeholder": "string",
"required": true,
"tabOrder": -9007199254740991,
"validations": {
"minLength": -9007199254740991,
"maxLength": -9007199254740991,
"pattern": "string",
"options": [
"string"
],
"property1": null,
"property2": null
},
"prefillValue": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"auditTrail": [
{
"id": "string",
"event": "string",
"occurredAt": "2019-08-24T14:15:22Z",
"actorEmail": "string",
"ipAddress": "string",
"userAgent": "string",
"metadata": {
"property1": null,
"property2": null
}
}
]
}
}Empty
Empty
Empty