How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Docupilot esign API

The esign API from Docupilot — 29 operation(s) for esign.

Docupilot esign API is one of 40 APIs that Docupilot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include eSign. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 37 operations across 29 paths, and defines 33 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against the base URL https://api-us1.docupilot.app.

37 operations 29 paths 33 schemas 4 DELETE18 GET4 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api-us1.docupilot.app
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Docupilot esign API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (OAuthAuthentication). An API key is passed in the cookie as sessionid (SessionAuthentication).

  • OAuthAuthentication — OAuth2 Bearer Token Authentication
  • SessionAuthentication — browser based login takes care of this

Paths & Operations 37

Across 29 paths, the API surfaces 37 operations — 4 DELETE, 18 GET, 4 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

esign 37
GET
/dashboard/esign/envelope-exports/
Get created envelope export
get_created_envelope_export 3 params → 200401403
POST
/dashboard/esign/envelope-exports/
Create envelope export task
create_envelope_export_task 2 params body → 201400401403
GET
/dashboard/esign/envelope-exports/{id}/download/
Download generated export envelopes if available
download_exported_envelopes 2 params → 200401403404
GET
/dashboard/esign/envelopes/
Get list of envelopes
list_envelopes 6 params → 200401403
POST
/dashboard/esign/envelopes/
Create a new envelope
create_envelope 1 param body → 201400401403
PATCH
/dashboard/esign/envelopes/{envelope_id}/documents/{id}/
Update envelope document
update_envelope_document 3 params body → 200400401403404
GET
/dashboard/esign/envelopes/{envelope_id}/recipients/
Get list of envelope recipients
list_envelope_recipients 5 params → 200401403
POST
/dashboard/esign/envelopes/{envelope_id}/recipients/
Create a new envelope recipient
create_envelope_recipient 2 params body → 201400401403404
PATCH
/dashboard/esign/envelopes/{envelope_id}/recipients/{id}/
Partial update of envelope recipient
update_envelope_recipient 3 params body → 200400401403404
DELETE
/dashboard/esign/envelopes/{envelope_id}/recipients/{id}/
Delete an envelope recipient
delete_envelope_recipient 3 params → 204400401403404
PATCH
/dashboard/esign/envelopes/{id}/
Update envelope config
update_envelope_config 2 params body → 200400401403404
DELETE
/dashboard/esign/envelopes/{id}/
Move envelope to trash
trash_envelope 2 params → 204400401403404
GET
/dashboard/esign/envelopes/{id}/attachment/{attachment_id}/download/
Download an individual attachment
download_attachment 4 params → 200401403404
POST
/dashboard/esign/envelopes/{id}/cancel/
Cancel an Envelope
cancel_envelope 2 params body → 204400401403404
POST
/dashboard/esign/envelopes/{id}/copy/
Copy an envelope
copy_envelope 2 params → 201400401403404
GET
/dashboard/esign/envelopes/{id}/details/
details of an envelope
envelope_details 2 params → 200401403404
GET
/dashboard/esign/envelopes/{id}/documents/{document_id}/download/
Download envelope file
download_envelope_file 4 params → 200400401403404
GET
/dashboard/esign/envelopes/{id}/documents/{document_id}/preview/
Preview Envelope
preview_envelope 4 params → 200400401403404
GET
/dashboard/esign/envelopes/{id}/download/
Download all envelope documents
download_envelope 3 params → 200401403404
POST
/dashboard/esign/envelopes/{id}/email_copy/
send copy via email
send_copy_via_email 2 params body → 204400401403404
GET
/dashboard/esign/envelopes/{id}/history/
envelope history
envelope_history 2 params → 200400401403404
DELETE
/dashboard/esign/envelopes/{id}/permanent_delete/
Delete a envelope permanently from trash
delete_envelope_permanently 2 params → 204400401403404
GET
/dashboard/esign/envelopes/{id}/recipient/{recipient_id}/attachments/download/
Download all attachments of an envelope recipient as a zip file
download_recipient_attachments 4 params → 200401403404
GET
/dashboard/esign/envelopes/{id}/responses/
Get consolidated field responses for an envelope
get_envelope_responses 3 params → 200401403404
POST
/dashboard/esign/envelopes/{id}/restore/
Restore a envelope from trash
restore_envelope_from_trash 2 params → 200400401403404
POST
/dashboard/esign/envelopes/{id}/send/
Send an Envelope
send_envelope 2 params body → 204400401403404
POST
/dashboard/esign/envelopes/{id}/send_reminder/
Send a reminder for Envelope Signers
send_reminder 2 params → 204400401403404
GET
/dashboard/esign/envelopes/{id}/signing-link/
Get signing link for the envelope (sender self-sign)
get_signing_link 2 params → 200400401403404
POST
/dashboard/esign/envelopes/bulk-move/
Bulk move envelopes across folders
bulk_move_envelopes 3 params body → 207400401403
GET
/dashboard/esign/envelopes/count/
Get envelope count grouped by status
envelope_count_by_status 1 param → 200401
GET
/dashboard/esign/envelopes/trash/
List all envelopes in trash
list_trashed_envelopes 2 params → 200401403
GET
/dashboard/esign/folders/{folder_id}/permissions/
Get all shared permissions for specific signature folder
list_esign_folder_sharing 2 params → 200401403
POST
/dashboard/esign/folders/{folder_id}/permissions/
Create signature folder sharing permission
create_esign_folder_sharing_permission 2 params body → 201400401403404
GET
/dashboard/esign/folders/{folder_id}/permissions/{id}/
Get specific permission details for given signature folder
get_esign_folder_sharing 3 params → 200401403404
PATCH
/dashboard/esign/folders/{folder_id}/permissions/{id}/
Update signature folder sharing permission partially
update_esign_folder_sharing_permission 3 params body → 200400401403404
DELETE
/dashboard/esign/folders/{folder_id}/permissions/{id}/
Revoke signature folder sharing permission
revoke_esign_folder_sharing_permission 3 params → 204400401403404
GET
/dashboard/esign/permissions/folder/
Get e-sign folder permissions
get_esign_folder_permissions 4 params → 200401403

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are EnvelopeDetails (29 properties), Envelope (25 properties), EnvelopeRecipient (15 properties), HistoryRecord (8 properties). Each schema is shown below with its type and property counts.

EnvelopeRecipient
object
15 properties 11 required
EnvelopeVoid
object
1 property 1 required
PaginatedEnvelopeRecipientList
object
4 properties 2 required
EnvelopeFolderSharing
object
3 properties 2 required
CreateEnvelope
object
3 properties 2 required
EnvelopeDetails
object
29 properties 9 required
PatchedEnvelopeDocumentsUpdate
object
1 property
SendEnvelopeViaEmail
object
1 property 1 required
EnvelopeHistory
object
8 properties 6 required
EnvelopeDocumentDownloadResponse
object
2 properties 2 required
CreateEnvelopeRecipient
object
2 properties 2 required
UnauthenticatedError
object
1 property 1 required
PatchedEnvelopeUpdate
object
7 properties
ForbiddenError
object
1 property 1 required
PatchedUpdateEnvelopeRecipient
object
5 properties
EnvelopeResponses
object
1 property 1 required
EnvelopeFieldResponse
object
6 properties 3 required
EnvelopeBulkMove
object
3 properties 1 required
SigningLinkResponse
object
1 property 1 required
PaginatedEnvelopeList
object
4 properties 2 required
EnvelopeBulkDownload
object
7 properties 5 required
EnvelopeStatusCountResponse
object
5 properties 5 required
PaginatedEnvelopeBulkDownloadList
object
4 properties 2 required
HistoryRecord
object
8 properties 6 required
BulkMoveEnvelopesResponse
object
4 properties 4 required
EnvelopeMoveFailureDetail
object
4 properties 4 required
PatchedUpdateEnvelopeFolderSharing
object
2 properties
ValidationError
object
2 properties 2 required
EnvelopeUpdate
object
7 properties
Envelope
object
25 properties 12 required
NotFoundError
object
1 property 1 required
EnvelopeExportDownloadResponse
object
2 properties 2 required
EnvelopeDocuments
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

docupilot-esign-api-openapi.yml Raw ↑

Other APIs Docupilot publishes across the network.

Docupilot ai API
Docupilot append API
Docupilot application API
Docupilot auth_tokens API
Docupilot community API
Docupilot content_blocks API
Docupilot convert API
Docupilot demographic API
Docupilot domain API
Docupilot esign-folders API
Docupilot esign-settings API
Docupilot extensions API
Where this information came from

This is an independent, third-party profile of Docupilot esign API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.