GET
/v1/signing-requests/{id}Read a signing request
One signing request and where each of its signers has got to. Reach for this to check a single envelope after a send or a reminder: it carries the status (open, completed, cancelled, expired), the expiry, and per signer their role, position, whether they have viewed, signed or declined, and how many times they have been chased.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:idstringoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": {
"cancelledAt": "string",
"cancelledReason": "string",
"completedAt": "string",
"createdAt": "string",
"createdBy": 1,
"dealId": "",
"documentId": "",
"documentTitle": "string",
"expiresAt": "string",
"id": "",
"message": "string",
"purpose": "string",
"rowId": "",
"signers": [
{
"blocked": "string",
"declineReason": "string",
"declinedAt": "string",
"email": "string",
"id": "",
"name": "string",
"order": "string",
"remindedAt": "string",
"reminderCount": "string",
"role": "string",
"signedAt": "string",
"status": "string",
"typedName": "string",
"viewedAt": "string"
}
],
"signingOrder": "string",
"status": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired