Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
Endpoints 34
AccountBrands
- GETGets a list of brands.
/v2.1/accounts/:accountId/brands?exclude_distributor_brand=string&include_logos=stringThis method returns details about all of the brands associated with an account, including the default brand profiles. Either or both of the following settings… - POSTCreates one or more brand profiles for an account.
/v2.1/accounts/:accountId/brandsThis method creates one or more brand profile files for an account. To specify logos for the brand, use the AccountBrands: updateLogo method after you create… - DELETEDeletes one or more brand profiles.
/v2.1/accounts/:accountId/brandsThis method deletes one or more brand profiles from an account, based on the brand IDs that you include in the brandsRequest. Either or both of the following… - GETGets information about a brand.
/v2.1/accounts/:accountId/brands/:brandId?include_external_references=string&include_logos=stringThis method returns details about an account brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend ,… - PUTUpdates an existing brand.
/v2.1/accounts/:accountId/brands/:brandId?replace_brand=stringThis method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or… - DELETEDeletes a brand.
/v2.1/accounts/:accountId/brands/:brandIdThis method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend ,… - GETExports a brand.
/v2.1/accounts/:accountId/brands/:brandId/fileThis method exports information about a brand to an XML file. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend ,… - GETGets a brand logo.
/v2.1/accounts/:accountId/brands/:brandId/logos/:logoTypeThis method returns a specific logo that is used in a brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend ,… - PUTUpdates a brand logo.
/v2.1/accounts/:accountId/brands/:brandId/logos/:logoTypeThis method updates a single brand logo. You pass in the new version of the resource in the Content-Disposition header. Example: Content-Disposition:… - DELETEDeletes a brand logo.
/v2.1/accounts/:accountId/brands/:brandId/logos/:logoTypeThis method deletes a single logo from an account brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend ,… - GETReturns metadata about the branding resources for an account.
/v2.1/accounts/:accountId/brands/:brandId/resourcesThis method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled… - GETReturns a branding resource file.
/v2.1/accounts/:accountId/brands/:brandId/resources/:resourceContentType?langcode=string&return_master=stringThis method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive… - PUTUpdates a branding resource file.
/v2.1/accounts/:accountId/brands/:brandId/resources/:resourceContentTypeThis method updates a branding resource file. You pass in the new version of the resource file in the Content-Disposition header. Example:…
AccountConsumerDisclosures
- GETGets the default Electronic Record and Signature Disclosure for an account.
/v2.1/accounts/:accountId/consumer_disclosure?langCode=stringRetrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. This is the default ERSD disclosure that… - GETGets the Electronic Record and Signature Disclosure for an account.
/v2.1/accounts/:accountId/consumer_disclosure/:langCodeRetrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. To set the language of the disclosure that you… - PUTUpdates the Electronic Record and Signature Disclosure for an account.
/v2.1/accounts/:accountId/consumer_disclosure/:langCode?include_metadata=stringAccount administrators can use this method to perform the following tasks: Customize values in the default disclosure. Switch to a custom disclosure that uses…
AccountCustomFields
- GETGets a list of custom fields.
/v2.1/accounts/:accountId/custom_fieldsThis method returns a list of the envelope and document custom fields associated with an account. - POSTCreates an account custom field.
/v2.1/accounts/:accountId/custom_fields?apply_to_templates=stringThis method creates a custom field and makes it available for all new envelopes associated with an account. - PUTUpdates an account custom field.
/v2.1/accounts/:accountId/custom_fields/:customFieldId?apply_to_templates=stringThis method updates an existing account custom field. - DELETEDeletes an account custom field.
/v2.1/accounts/:accountId/custom_fields/:customFieldId?apply_to_templates=stringThis method deletes an existing account custom field.
EnvelopeCustomFields
- GETGets the custom field information for the specified envelope.
/v2.1/accounts/:accountId/envelopes/:envelopeId/custom_fieldsRetrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the… - PUTUpdates envelope custom fields in an envelope.
/v2.1/accounts/:accountId/envelopes/:envelopeId/custom_fieldsUpdates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. - POSTCreates envelope custom fields for an envelope.
/v2.1/accounts/:accountId/envelopes/:envelopeId/custom_fieldsUpdates the envelope custom fields for draft and in-process envelopes. Related topics How to bulk send envelopes - DELETEDeletes envelope custom fields for draft and in-process envelopes.
/v2.1/accounts/:accountId/envelopes/:envelopeId/custom_fieldsDeletes envelope custom fields for draft and in-process envelopes.
EnvelopeDocumentFields
- GETGets the custom document fields from an existing envelope document.
/v2.1/accounts/:accountId/envelopes/:envelopeId/documents/:documentId/fieldsRetrieves the custom document field information from an existing envelope document. - PUTUpdates existing custom document fields in an existing envelope document.
/v2.1/accounts/:accountId/envelopes/:envelopeId/documents/:documentId/fieldsUpdates existing custom document fields in an existing envelope document. - POSTCreates custom document fields in an existing envelope document.
/v2.1/accounts/:accountId/envelopes/:envelopeId/documents/:documentId/fieldsCreates custom document fields in an existing envelope document. - DELETEDeletes custom document fields from an existing envelope document.
/v2.1/accounts/:accountId/envelopes/:envelopeId/documents/:documentId/fieldsDeletes custom document fields from an existing envelope document.
EnvelopeLocks
- GETGets envelope lock information.
/v2.1/accounts/:accountId/envelopes/:envelopeId/lockRetrieves general information about an envelope lock. The user requesting the information must be the same user who locked the envelope. You can use this… - PUTUpdates an envelope lock.
/v2.1/accounts/:accountId/envelopes/:envelopeId/lockUpdates the lock information for a locked envelope. You must include the X-DocuSign-Edit header as described in EnvelopeLocks: create. Use this method to… - POSTLocks an envelope.
/v2.1/accounts/:accountId/envelopes/:envelopeId/lockThis method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope. The… - DELETEDeletes an envelope lock.
/v2.1/accounts/:accountId/envelopes/:envelopeId/lockDeletes the lock from the specified envelope. The user deleting the lock must be the same user who locked the envelope. You must include the X-DocuSign-Edit…
EnvelopeRecipients
- GETGets the status of recipients for an envelope.
/v2.1/accounts/:accountId/envelopes/:envelopeId/recipients?include_anchor_tab_locations=string&include_extended=string&include_metadata=string&include_tabs=stringRetrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve… - PUTUpdates recipients in a draft envelope or corrects recipient information for an in-process envelope.
/v2.1/accounts/:accountId/envelopes/:envelopeId/recipients?combine_same_order_recipients=string&offline_signing=string&resend_envelope=stringUpdates the recipients of a draft envelope or corrects recipient information for an in-process envelope. If you send information for a recipient that does not…
API details
- Base URL
https://www.docusign.net/restapi- Authentication
- None declared in the description
- Operations
- 414 operations on 213 pathsGET 167PUT 105DELETE 77POST 65
- Main resources
- EnvelopeWorkflowDefinition 26Envelopes 17Accounts 16ConnectConfigurations 14Templates 14AccountBrands 13BulkSend 12Users 11AccountSignatures 9UserSignatures 9
- Response formats
application/json- Description format
- Swagger 2.0, API version
v2.1 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Docusign eSignature REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Docusign eSignature REST API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Gets a list of brands.” (GET /v2.1/accounts/:accountId/brands?exclude_distributor_brand=string&include_logos=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Docusign eSignature REST API?
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. It is listed under Other and has 414 endpoints.
Who publishes the Docusign eSignature REST API?
It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Docusign eSignature REST API?
Requests go to https://www.docusign.net/restapi. Endpoint paths are added to this base URL.
How do I authenticate with the Docusign eSignature REST API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Docusign eSignature REST API have?
414 operations on 213 paths (167 GET, 105 PUT, 77 DELETE, 65 POST). The largest groups are EnvelopeWorkflowDefinition, Envelopes, Accounts, ConnectConfigurations. This listing's collection holds the first 400.
Is forking the Docusign eSignature REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.