{"@context": "https://schema.org", "@type": "WebAPI", "name": "DocuSign REST API API", "description": "The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.", "provider": {"@type": "Organization", "name": "docusign.net"}, "documentation": "https://raw.githubusercontent.com/docusign/eSign-OpenAPI-Specification/master/esignature.rest.swagger-v2.1.json"}
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://www.docusign.net/restapi
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
| method | path | what the vendor says it does |
|---|---|---|
GET | /service_information | Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign Production sys |
GET | /v2.1 | Lists resources for REST version specified Retrieves the base resources available for the eSignature REST API. |
POST | /v2.1/accounts | Creates new accounts. Creates new DocuSign accounts. You can use this method to create a single account or up |
GET | /v2.1/accounts/provisioning | Retrieves the account provisioning information for the account. Retrieves the account provisioning information |
GET | /v2.1/accounts/{accountId} | Retrieves the account information for the specified account. Retrieves the account information for the specifi |
DELETE | /v2.1/accounts/{accountId} | Deletes the specified account. This closes the specified account. You must be an account admin to close your a |
GET | /v2.1/accounts/{accountId}/billing_charges | Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges fo |
GET | /v2.1/accounts/{accountId}/billing_invoices | Get a List of Billing Invoices Retrieves a list of invoices for the account. If the from date or to date queri |
GET | /v2.1/accounts/{accountId}/billing_invoices/{invoiceId} | Retrieves a billing invoice. Retrieves the specified invoice. **Note:** If the `pdfAvailable` property in the |
GET | /v2.1/accounts/{accountId}/billing_invoices_past_due | Get a list of past due invoices. Returns a list past due invoices for the account and notes if payment can be |
GET | /v2.1/accounts/{accountId}/billing_payments | Gets payment information for one or more payments. Retrieves a list containing information about one or more p |
POST | /v2.1/accounts/{accountId}/billing_payments | Posts a payment to a past due invoice. Posts a payment to a past due invoice. This method can only be used if |
GET | /v2.1/accounts/{accountId}/billing_payments/{paymentId} | Gets billing payment information for a specific payment. Retrieves the information for a specified payment. |
GET | /v2.1/accounts/{accountId}/billing_plan | Get Account Billing Plan Retrieves the billing plan information for the specified account, including the curre |
PUT | /v2.1/accounts/{accountId}/billing_plan | Updates an account billing plan. Updates the billing plan information, billing address, and credit card inform |
GET | /v2.1/accounts/{accountId}/billing_plan/credit_card | Get credit card information This method returns information about a credit card associated with an account. Bi |
GET | /v2.1/accounts/{accountId}/billing_plan/downgrade | Returns downgrade plan information for the specified account. BillingPlans |
PUT | /v2.1/accounts/{accountId}/billing_plan/downgrade | Queues downgrade billing plan request for an account. BillingPlans |
PUT | /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes | Reserved: Purchase additional envelopes. Reserved: At this time, this endpoint is limited to DocuSign internal |
GET | /v2.1/accounts/{accountId}/brands | Gets a list of brands. This method returns details about all of the brands associated with an account, includi |
POST | /v2.1/accounts/{accountId}/brands | Creates one or more brand profiles for an account. This method creates one or more brand profile files for an |
DELETE | /v2.1/accounts/{accountId}/brands | Deletes one or more brand profiles. This method deletes one or more brand profiles from an account, based on t |
GET | /v2.1/accounts/{accountId}/brands/{brandId} | Gets information about a brand. This method returns details about an account brand. **Note:** Branding for ei |
PUT | /v2.1/accounts/{accountId}/brands/{brandId} | Updates an existing brand. This method updates an account brand. **Note:** Branding for either signing or se |
DELETE | /v2.1/accounts/{accountId}/brands/{brandId} | Deletes a brand. This method deletes a brand from an account. **Note:** Branding for either signing or sendin |
GET | /v2.1/accounts/{accountId}/brands/{brandId}/file | Exports a brand. This method exports information about a brand to an XML file. **Note:** Branding for either |
GET | /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} | Gets a brand logo. This method returns a specific logo that is used in a brand. **Note:** Branding for either |
PUT | /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} | Updates a brand logo. This method updates a single brand logo. You pass in the new version of the resource in |
DELETE | /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} | Deletes a brand logo. This method deletes a single logo from an account brand. **Note:** Branding for either |
GET | /v2.1/accounts/{accountId}/brands/{brandId}/resources | Returns metadata about the branding resources for an account. This method returns metadata about the branding |
GET | /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} | Returns a branding resource file. This method returns a specific branding resource file. A brand uses a set o |
PUT | /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} | Updates a branding resource file. This method updates a branding resource file. You pass in the new version o |
GET | /v2.1/accounts/{accountId}/bulk_send_batch | Returns a list of bulk send batch summaries. Returns a summary of bulk send batches. Use the `batch_ids` quer |
GET | /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId} | Gets the status of a specific bulk send batch. Gets the general status of a specific bulk send batch such as: |
PUT | /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId} | Updates the name of a bulk send batch. Updates the name of a bulk send batch. BulkSend |
GET | /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes | Gets envelopes from a specific bulk send batch. This method returns a list of envelopes in a specified bulk ba |
PUT | /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction} | Applies a bulk action to all envelopes from a specified bulk send. Use this endpoint to resend, correct, or vo |
GET | /v2.1/accounts/{accountId}/bulk_send_lists | Gets bulk send lists. This method returns a list of bulk send lists belonging to the current user, as well as |
POST | /v2.1/accounts/{accountId}/bulk_send_lists | Creates a bulk send list. This method creates a bulk send list that you can use to send an envelope to up to 1 |
GET | /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} | Gets a specific bulk send list. This method returns all of the details associated with a specific bulk send li |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/docusign/eSign-OpenAPI-Specification/master/esignature.r
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.