--- title: Get e-Signature Job Status slug: get-e-signature-job-status docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "Rsy0P2cvkf7vmoNrf6Z3Z", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId}", "servers": [ { "url": "https://api.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId}", "description": "Nue API Production URL" }, { "url": "https://api.sandbox.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId}", "description": "Nue Sandbox API Server" } ], "name": "Get e-Signature Job Status", "description": "

Retrieve the current status of an e-signature job, including job execution details, envelope information, and recipient status. Use this endpoint to track the progress of asynchronous e-signature requests.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "jobId", "type": "string", "example": "3838d6cf-e5df-42fd-b4d6-2d5b953ec704", "description": "

The unique identifier of the e-signature job returned when the quote was sent for signature

", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

API key for authentication. Format: Bearer {your-api-key}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successfully retrieved signature status", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Successfully retrieved signature status\n{\n \"id\": \"3838d6cf-e5df-42fd-b4d6-2d5b953ec704\",\n \"name\": \"Send for e-Sign\",\n \"type\": \"E-Signature-Create\",\n \"status\": \"Completed\",\n \"progress\": 0,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 39,\n \"startTime\": \"2026-01-04T18:35:13.355\",\n \"endTime\": \"2026-01-04T18:35:52.785\",\n \"result\": {\n \"quoteId\": \"0Q0RL000002cxsL0AQ\",\n \"envelopeId\": \"02862824-5324-840f-80fb-3da56411044c\",\n \"status\": \"sent\",\n \"recipients\": [\n {\n \"recipientId\": \"1\",\n \"name\": \"Jack Chen\",\n \"email\": \"mike.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n },\n \"createdAt\": \"2026-01-04T10:35:46.5470000Z\",\n \"expiresAt\": \"2026-05-04T10:35:49.1600000Z\"\n }\n}" }, { "label": "Completed Job", "code": "{\n \"id\": \"3838d6cf-e5df-42fd-b4d6-2d5b953ec704\",\n \"name\": \"Send for e-Sign\",\n \"type\": \"E-Signature-Create\",\n \"status\": \"Completed\",\n \"progress\": 0,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 39,\n \"startTime\": \"2026-01-04T18:35:13.355\",\n \"endTime\": \"2026-01-04T18:35:52.785\",\n \"result\": {\n \"quoteId\": \"0Q0RL000002cxsL0AQ\",\n \"envelopeId\": \"02862824-5324-840f-80fb-3da56411044c\",\n \"status\": \"sent\",\n \"recipients\": [\n {\n \"recipientId\": \"1\",\n \"name\": \"Jack Chen\",\n \"email\": \"mike.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n },\n {\n \"recipientId\": \"2\",\n \"name\": \"Mike Wick\",\n \"email\": \"mike.wick@company.com\",\n \"role\": \"Manager\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n },\n \"createdAt\": \"2026-01-04T10:35:46.5470000Z\",\n \"expiresAt\": \"2026-05-04T10:35:49.1600000Z\"\n }\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ESignatureJobResponse", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "

Unique identifier for the e-signature job

", "example": "3838d6cf-e5df-42fd-b4d6-2d5b953ec704", "format": "uuid" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the job", "example": "Send for e-Sign" }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of the job", "example": "E-Signature-Create" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the job", "example": "Completed", "enum": [ "Pending", "InProgress", "Completed", "Failed" ] }, { "name": "progress", "kind": "optional", "type": "integer", "description": "

Progress percentage of the job (0-100)

", "example": 0 }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Error code if the job failed", "example": "" }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "Error message if the job failed", "example": "" }, { "name": "executionSeconds", "kind": "optional", "type": "integer", "description": "Total execution time in seconds", "example": 39 }, { "name": "startTime", "kind": "optional", "type": "string", "description": "Date and time when the job started", "example": "2026-01-04T18:35:13.355", "format": "date-time" }, { "name": "endTime", "kind": "optional", "type": "string", "description": "Date and time when the job ended", "example": "2026-01-04T18:35:52.785", "format": "date-time" }, { "name": "result", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ESignatureResult", "customType": "ESignatureResult", "schema": [ { "name": "quoteId", "kind": "optional", "type": "string", "description": "The quote ID that was sent for signature", "example": "0Q0RL000002cxsL0AQ" }, { "name": "envelopeId", "kind": "optional", "type": "string", "description": "

Unique identifier for the e-signature envelope

", "example": "02862824-5324-840f-80fb-3da56411044c", "format": "uuid" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the envelope", "example": "sent", "enum": [ "created", "sent", "delivered", "completed", "declined", "voided" ] }, { "name": "recipients", "kind": "optional", "type": "array", "description": "List of all recipients and their current status", "modelRef": "#/components/schemas/RecipientStatus", "customType": "RecipientStatus[]", "schema": [ { "name": "recipientId", "kind": "optional", "type": "string", "description": "Unique identifier for the recipient", "example": "1" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the recipient", "example": "Jack Chen" }, { "name": "email", "kind": "optional", "type": "string", "description": "Email address of the recipient", "example": "mike.chen@company.com", "format": "email" }, { "name": "role", "kind": "optional", "type": "string", "description": "Role of the recipient", "example": "Customer" }, { "name": "action", "kind": "optional", "type": "string", "description": "Action required from the recipient", "example": "Needs to Sign" }, { "name": "recipientStatus", "kind": "optional", "type": "string", "description": "Current status of the recipient", "example": "sent", "enum": [ "created", "sent", "delivered", "completed", "declined", "autoresponded" ] } ] }, { "name": "email", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/EmailContent", "customType": "EmailContent", "schema": [ { "name": "subject", "kind": "required", "type": "string", "description": "Email subject line for the signature request", "example": "Order Form for your e-Signature (Sent by API)" }, { "name": "message", "kind": "required", "type": "string", "description": "Email message body for the signature request", "example": "This is a request for your electronic signature, please review your order form and electronically sign by following the link below." } ] }, { "name": "createdAt", "kind": "optional", "type": "string", "description": "Date and time when the envelope was created", "example": "2026-01-04T10:35:46.5470000Z", "format": "date-time" }, { "name": "expiresAt", "kind": "optional", "type": "string", "description": "Date and time when the signature request expires", "example": "2026-05-04T10:35:49.1600000Z", "format": "date-time" } ] } ], "modelRef": "#/components/schemas/ESignatureJobResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized - Invalid or missing API key

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "error", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code", "example": "INVALID_DOCUMENT" }, { "name": "message", "kind": "optional", "type": "string", "description": "Error message", "example": "Document not found or cannot be sent for signature" }, { "name": "details", "kind": "optional", "type": "array", "description": "Additional error details", "example": "[\"Document must be in Draft or Pending status to send for signature\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "

Not Found - Job does not exist

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "error", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code", "example": "INVALID_DOCUMENT" }, { "name": "message", "kind": "optional", "type": "string", "description": "Error message", "example": "Document not found or cannot be sent for signature" }, { "name": "details", "kind": "optional", "type": "array", "description": "Additional error details", "example": "[\"Document must be in Draft or Pending status to send for signature\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "QS3CO5OcNugF2gbetGx8H", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId} \\\n --header 'accept: application/json'" }, { "id": "_ZOGuSl7Q3bh8ky3DJiEm", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "rnT2MtXbnwN-_jxCA4m64", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "QbZH81g1fUtNVp66dnc7q", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/v1/cpq/quotes/e-sign/jobs/{jobId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "QS3CO5OcNugF2gbetGx8H" }, "results": { "languages": [ { "id": "9TycyeXcdc2kYPTqci-0e", "language": "200", "code": "// Successfully retrieved signature status\n{\n \"id\": \"3838d6cf-e5df-42fd-b4d6-2d5b953ec704\",\n \"name\": \"Send for e-Sign\",\n \"type\": \"E-Signature-Create\",\n \"status\": \"Completed\",\n \"progress\": 0,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 39,\n \"startTime\": \"2026-01-04T18:35:13.355\",\n \"endTime\": \"2026-01-04T18:35:52.785\",\n \"result\": {\n \"quoteId\": \"0Q0RL000002cxsL0AQ\",\n \"envelopeId\": \"02862824-5324-840f-80fb-3da56411044c\",\n \"status\": \"sent\",\n \"recipients\": [\n {\n \"recipientId\": \"1\",\n \"name\": \"Jack Chen\",\n \"email\": \"mike.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n },\n \"createdAt\": \"2026-01-04T10:35:46.5470000Z\",\n \"expiresAt\": \"2026-05-04T10:35:49.1600000Z\"\n }\n}", "subExamples": [ { "label": "GENERATED", "code": "// Successfully retrieved signature status\n{\n \"id\": \"3838d6cf-e5df-42fd-b4d6-2d5b953ec704\",\n \"name\": \"Send for e-Sign\",\n \"type\": \"E-Signature-Create\",\n \"status\": \"Completed\",\n \"progress\": 0,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 39,\n \"startTime\": \"2026-01-04T18:35:13.355\",\n \"endTime\": \"2026-01-04T18:35:52.785\",\n \"result\": {\n \"quoteId\": \"0Q0RL000002cxsL0AQ\",\n \"envelopeId\": \"02862824-5324-840f-80fb-3da56411044c\",\n \"status\": \"sent\",\n \"recipients\": [\n {\n \"recipientId\": \"1\",\n \"name\": \"Jack Chen\",\n \"email\": \"mike.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n },\n \"createdAt\": \"2026-01-04T10:35:46.5470000Z\",\n \"expiresAt\": \"2026-05-04T10:35:49.1600000Z\"\n }\n}" }, { "label": "Completed Job", "code": "{\n \"id\": \"3838d6cf-e5df-42fd-b4d6-2d5b953ec704\",\n \"name\": \"Send for e-Sign\",\n \"type\": \"E-Signature-Create\",\n \"status\": \"Completed\",\n \"progress\": 0,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 39,\n \"startTime\": \"2026-01-04T18:35:13.355\",\n \"endTime\": \"2026-01-04T18:35:52.785\",\n \"result\": {\n \"quoteId\": \"0Q0RL000002cxsL0AQ\",\n \"envelopeId\": \"02862824-5324-840f-80fb-3da56411044c\",\n \"status\": \"sent\",\n \"recipients\": [\n {\n \"recipientId\": \"1\",\n \"name\": \"Jack Chen\",\n \"email\": \"mike.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n },\n {\n \"recipientId\": \"2\",\n \"name\": \"Mike Wick\",\n \"email\": \"mike.wick@company.com\",\n \"role\": \"Manager\",\n \"action\": \"Needs to Sign\",\n \"recipientStatus\": \"sent\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n },\n \"createdAt\": \"2026-01-04T10:35:46.5470000Z\",\n \"expiresAt\": \"2026-05-04T10:35:49.1600000Z\"\n }\n}" } ] }, { "id": "GnkO1vcri1yN0-U6IomKx", "language": "401", "code": "// Unauthorized - Invalid or missing API key\n{\n \"error\": {\n \"code\": \"INVALID_DOCUMENT\",\n \"message\": \"Document not found or cannot be sent for signature\",\n \"details\": [\n \"\"\n ]\n }\n}" }, { "id": "xFSx7cKfSgE2WCKheEh8E", "language": "404", "code": "// Not Found - Job does not exist\n{\n \"error\": {\n \"code\": \"INVALID_DOCUMENT\",\n \"message\": \"Document not found or cannot be sent for signature\",\n \"details\": [\n \"\"\n ]\n }\n}" } ], "selectedLanguageId": "9TycyeXcdc2kYPTqci-0e" } }, "children": [ { "text": "" } ] }