{ "opencollection": "1.0.0", "info": { "name": "Docupilot accounts APIs ai esign API", "version": "1.0" }, "items": [ { "info": { "name": "esign", "type": "folder" }, "items": [ { "info": { "name": "Get created envelope export", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelope-exports/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get created envelope export" }, { "info": { "name": "Create envelope export task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelope-exports/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "status", "value": "", "type": "query", "description": "Status filter" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Create envelope export task" }, { "info": { "name": "Download generated export envelopes if available", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelope-exports/:id/download/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Download generated export envelopes if available" }, { "info": { "name": "Get list of envelopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder", "value": "", "type": "query", "description": "Filter by folder id" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "status", "value": "", "type": "query", "description": "Filter by status" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get list of envelopes" }, { "info": { "name": "Create a new envelope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/", "headers": [ { "name": "X-Workspace", "value": "" } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new envelope" }, { "info": { "name": "Update envelope document", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/dashboard/esign/envelopes/:envelope_id/documents/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "envelope_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update envelope document" }, { "info": { "name": "Get list of envelope recipients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:envelope_id/recipients/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "envelope_id", "value": "", "type": "path" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get list of envelope recipients" }, { "info": { "name": "Create a new envelope recipient", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:envelope_id/recipients/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "envelope_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new envelope recipient" }, { "info": { "name": "Partial update of envelope recipient", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/dashboard/esign/envelopes/:envelope_id/recipients/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "envelope_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partial update of envelope recipient" }, { "info": { "name": "Delete an envelope recipient", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dashboard/esign/envelopes/:envelope_id/recipients/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "envelope_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an envelope recipient" }, { "info": { "name": "Update envelope config", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update envelope config" }, { "info": { "name": "Move envelope to trash", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Move envelope to trash" }, { "info": { "name": "Download an individual attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/attachment/:attachment_id/download/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "attachment_id", "value": "", "type": "path" }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download an individual attachment" }, { "info": { "name": "Cancel an Envelope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/cancel/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel an Envelope" }, { "info": { "name": "Copy an envelope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/copy/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Copy an envelope" }, { "info": { "name": "details of an envelope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/details/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "details of an envelope" }, { "info": { "name": "Download envelope file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/documents/:document_id/download/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." }, { "name": "response_type", "value": "", "type": "query", "description": "If stream, returns the document as a downloadable file. If url, returns JSON with file_url and file_name." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download envelope file" }, { "info": { "name": "Preview Envelope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/documents/:document_id/preview/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "document_id", "value": "", "type": "path" }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Preview Envelope" }, { "info": { "name": "Download all envelope documents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/download/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "history", "value": "", "type": "query", "description": "Whether to include history in the response" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download all envelope documents" }, { "info": { "name": "send copy via email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/email_copy/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "send copy via email" }, { "info": { "name": "envelope history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/history/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "envelope history" }, { "info": { "name": "Delete a envelope permanently from trash", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/permanent_delete/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a envelope permanently from trash" }, { "info": { "name": "Download all attachments of an envelope recipient as a zip file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/recipient/:recipient_id/attachments/download/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." }, { "name": "recipient_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download all attachments of an envelope recipient as a zip file" }, { "info": { "name": "Get consolidated field responses for an envelope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/responses/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." }, { "name": "recipient_id", "value": "", "type": "query", "description": "Filter responses by recipient id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get consolidated field responses for an envelope" }, { "info": { "name": "Restore a envelope from trash", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/restore/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Restore a envelope from trash" }, { "info": { "name": "Send an Envelope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/send/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send an Envelope" }, { "info": { "name": "Send a reminder for Envelope Signers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/send_reminder/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send a reminder for Envelope Signers" }, { "info": { "name": "Get signing link for the envelope (sender self-sign)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/:id/signing-link/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get signing link for the envelope (sender self-sign)" }, { "info": { "name": "Bulk move envelopes across folders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/envelopes/bulk-move/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder", "value": "", "type": "query", "description": "Restrict bulk move to envelopes currently in this folder" }, { "name": "status", "value": "", "type": "query", "description": "Filter envelopes by status when moving all envelopes" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Bulk move envelopes across folders" }, { "info": { "name": "Get envelope count grouped by status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/count/", "headers": [ { "name": "X-Workspace", "value": "" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get envelope count grouped by status" }, { "info": { "name": "List all envelopes in trash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/envelopes/trash/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all envelopes in trash" }, { "info": { "name": "Get all shared permissions for specific signature folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/folders/:folder_id/permissions/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get all shared permissions for specific signature folder" }, { "info": { "name": "Create signature folder sharing permission", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard/esign/folders/:folder_id/permissions/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Create signature folder sharing permission" }, { "info": { "name": "Get specific permission details for given signature folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/folders/:folder_id/permissions/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope folder sharing setting." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get specific permission details for given signature folder" }, { "info": { "name": "Update signature folder sharing permission partially", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/dashboard/esign/folders/:folder_id/permissions/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope folder sharing setting." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Update signature folder sharing permission partially" }, { "info": { "name": "Revoke signature folder sharing permission", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dashboard/esign/folders/:folder_id/permissions/:id/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this envelope folder sharing setting." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Revoke signature folder sharing permission" }, { "info": { "name": "Get e-sign folder permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/esign/permissions/folder/", "headers": [ { "name": "X-Workspace", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query" }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get e-sign folder permissions" } ] } ], "bundled": true }