Skip to main content

​
Endpoint

GET /tasks/{task_id}/signed-documents

​
Authentication

This endpoint requires authentication via API key. Include your API key in the X-API-Key header: 
X-API-Key: ca_your_api_key_here

​
Path Parameters

ParameterTypeRequiredDescription
task_idintegerYesUnique identifier for the task

​
Request Example

curl -X GET "https://platform.chamelio.ai/tasks/12345/signed-documents" \
  -H "X-API-Key: ca_your_api_key_here"

import requests

task_id = 12345

url = f"https://platform.chamelio.ai/tasks/{task_id}/signed-documents"
headers = {
    "X-API-Key": "ca_your_api_key_here"
}

response = requests.get(url, headers=headers)
print(response.json())

const taskId = 12345;

const response = await fetch(
  `https://platform.chamelio.ai/tasks/${taskId}/signed-documents`,
  {
    method: 'GET',
    headers: {
      'X-API-Key': 'ca_your_api_key_here'
    }
  }
);

const data = await response.json();
console.log(data);

​
Response

​
Success Response

Status Code: 200 OK 
{
  "task_id": 12345,
  "workflow_status": "completed",
  "total": 2,
  "documents": [
    {
      "file_id": "document_789",
      "file_name": "signed_contract.pdf",
      "step_id": "sign_step_1",
      "step_name": "Executive Signature",
      "download_url": "https://s3.amazonaws.com/chamelio-files/...",
      "expires_at": "2025-01-20T12:00:00Z"
    },
    {
      "file_id": "document_790",
      "file_name": "signed_nda.pdf",
      "step_id": "sign_step_2",
      "step_name": "NDA Signature",
      "download_url": "https://s3.amazonaws.com/chamelio-files/...",
      "expires_at": "2025-01-20T12:00:00Z"
    }
  ]
}

​
Response Fields

FieldTypeDescription
task_idintegerID of the task
workflow_statusstringCurrent status of the workflow
totalintegerTotal number of signed documents
documentsarrayList of signed documents associated with the task

​
Document Object Fields

FieldTypeDescription
file_idstringUnique identifier of the signed document
file_namestringName of the signed document file
step_idstringID of the workflow step that produced this signed document
step_namestringDisplay name of the workflow step
download_urlstringPresigned URL to download the signed document
expires_atstringISO 8601 timestamp when the download URL expires

​
Error Responses

​
401 Unauthorized

Returned when authentication fails. See the authentication errors section for details. 
{
  "detail": "Invalid API key"
}

​
404 Not Found

Returned when the task doesn’t exist or you don’t have access to it. 
{
  "detail": "Task not found"
}

​
500 Internal Server Error

Returned when the request fails due to a server error. 
{
  "detail": "Failed to retrieve signed documents"
}

​
Notes

This endpoint returns signed documents from all signature steps within the task. The total field reflects the count of documents in the response.
Presigned download URLs expire after a certain time (indicated by expires_at on each document). Download the files before the URLs expire or request new URLs.
Use the step_name field to identify which signature step each document belongs to, especially when a workflow contains multiple signing steps.

​
Use Cases

This endpoint is useful for:
  • Post-signing retrieval - Download fully executed contracts after all parties have signed
  • Document archival - Save signed documents to long-term storage or a contract management system
  • Audit trails - Verify which documents were signed as part of a workflow
  • Integration - Sync signed contracts with ERP, CRM, or document management platforms