Articles in this section

Available Docusign APIs

When you configure an export, import, or other type of flow step using the prebuilt Docusign connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Docusign API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Accounts: Account brands

Get information for a specific brand

X

Export a specific brand

X

Obtains the specified image for a brand

X

Returns the specified branding resource file

X

Gets a list of brand profiles

X

Returns the specified account's list of branding resources (metadata)

X

Create

X

Delete

X

Update

X

Accounts: Account consumer disclosures

Gets the electronic record and signature disclosure

X

Gets the electronic record and signature disclosure for the account

X

Accounts: Account custom fields

Gets a list of custom fields associated with the account

X

Create

X

Update

X

Delete

X

Accounts: Account password rules

Get the password rules

X

Get membership account password rules

X

Accounts: Account permission profiles

Returns a permissions profile in the specified account

X

Gets a list of permission profiles

X

Accounts: Accounts

Retrieves the account information for the specified account

X

Gets list of recurring and usage charges for the account

X

Retrieves the account provisioning information for the account

X

Retrieves a list of recipients in the specified account that are associated with an email address supplied in the query string

X

Retrieves the account settings information for the specified account

X

Retrieves shared item status for one or more users and types of items

X

Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the Docusign system

X

Accounts: Account signature providers

Returns account available signature providers for specified account

X

Accounts: Account tab settings

Returns tab settings list for specified account

X

Accounts: Account watermarks

Get watermark information

X

Accounts: Enote configurations

Gets enote configuration associated with the account

X

Billing: Billing plans

Retrieves the billing plan details for the specified billing plan ID

X

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card

X

Retrieves the credit card details

X

Retrieves a list of the billing plans associated with a distributor

X

Billing: Invoices

Retrieves the specified invoice

X

Retrieves a list of invoices for the account

X

Returns a list past due invoices for the account and notes if payment can be made through the REST API

X

Billing: Payments

Retrieves the information for a specified payment

X

Retrieves a list containing information about one or more payments

X

Bulk envelopes: Bulk envelopes

Retrieves the status information of a single bulk recipient batch

X

Retrieves status information about all the bulk recipient batches

X

Bulk envelopes: Envelope bulk recipients

Retrieves the bulk recipient file information from an envelope that has a bulk recipient

X

Cloud storage: Cloudstorage

Retrieves a list of the user's items from the specified cloud storage provider

X

Retrieves a list of all the items in a specified folder from the specified cloud storage provider

X

Cloud storage: Cloud storage providers

Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user

X

Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user

X

Connect: Connect configurations

Retrieves the information for the specified Docusign connect configuration

X

Retrieves all the Docusign custom connect definitions for the specified account

X

Returns users from the configured connect service

X

Connect: Connect events

Retrieves the specified connect log entry for your account

X

Retrieves a list of connect log entries for your account

X

Retrieves the connect failure log information

X

Connect: Connect mobile notifiers

The connect mobile notifications resource is reserved for Docusign use only

X

Custom tabs: Custom tabs

Retrieves information about the requested custom tab on the specified account

X

Retrieves a list of all tabs associated with the account

X

Diagnostics: Request logs

Retrieves information for a single log entry

X

Retrieves the current API request logging setting for the user and remaining log entries

X

Retrieves a list of log entries as a JSON or XML object or as a zip file containing the entries

X

Diagnostics: Resources

Retrieves the base resources available for the Docusign REST APIs

X

Diagnostics: Services

Retrieves the available REST API versions

X

Envelopes: Chunked uploads

Get chunk with upload ID

X

Envelopes: Envelope attachments

Get attachment with attachment ID

X

Get list of attachments

X

Envelopes: Envelope consumer disclosures

Retrieves the electronic record and signature disclosure, with HTML formatting, associated with the account.(by langcode)

X

Retrieves the electronic record and signature disclosure, with HTML formatting, associated with the account

X

Envelopes: Envelope document fields

Retrieves the custom document field information from an existing envelope document

X

Envelopes: Envelope documents

Retrieves the specified document from the envelope

X

Retrieves a list of documents associated with the specified envelope

X

Envelopes: Envelope document tabs

Retrieves the list of tabs in a document

X

Retrieves the list of tabs in a page

X

Envelopes: Envelope document visibility

Document visibility

X

Envelopes: Envelope email settings

Retrieves the email override settings for the specified envelope

X

Envelopes: Envelope form data

Retrieves recipient's form data

X

Envelopes: Envelope locks

Retrieves general information about the envelope lock

X

Envelopes: Envelope recipient tabs

Retrieves information about the tabs associated with a recipient in a draft envelope

X

Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list

X

Envelopes: Envelopes

Retrieves the overall status for the specified envelope

X

Retrieves the envelope notification, reminders, and expirations, information for an existing envelope

X

Retrieves a page image for display from the specified envelope

X

Retrieves pages in a document

X

Retrieves the initials image for the specified user

X

Retrieves signature information for a signer or sign-in-person recipient

X

Retrieves the specified user signature image

X

Gets the envelope audit events for the specified envelope

X

Retrieves a list of envelopes that match your request’s filters

X

Envelopes: Envelope templates

This returns a list of the server-side templates, their name, and ID, used in an envelope

X

Retrieves the templates associated with a document in the specified envelope

X

Folders: Folders

Retrieves a list of the folders for the account, including the folder hierarchy

X

Retrieves a list of the envelopes in the specified folder

X

Retrieves a list of envelopes that match the criteria specified in the query

X

Power forms: Power form data

Retrieves form data for given power form ID

X

Power forms: Power forms

Retrieves power form for the given power form ID

X

Retrieves list of power forms available to the user

X

Retrieves a list of users who have sent power forms

X

Signing groups: Signing groups

Retrieves a list of all signing groups in the specified account

X

Retrieves information, including group member information, for the specified signing group

X

Signing groups: Signing group users

Retrieves the list of members in the specified signing group

X

Templates: Template bulk recipients

Retrieves the bulk recipient file information from a template that has a bulk recipient

X

Templates: Template custom fields

Retrieves the custom document field information from an existing template

X

Templates: Template document fields

Retrieves the custom document fields for an existing template document

X

Templates: Template documents

Retrieves one or more PDF documents from the specified template

X

Retrieves a list of documents associated with the specified template

X

Templates: Template document tabs

Retrieves all tabs in a given document ID

X

Retrieves all tabs in a given page number

X

Templates: Template document visibility

Retrieves all tabs in a given document ID

X

Templates: Template locks

Retrieves general information about the template lock

X

Templates: Template recipient tabs

Gets the tabs information for a signer or sign-in-person recipient in a template

X

Templates: Templates

Retrieves the definition of the specified template

X

Retrieves a page image for display from the specified template

X

Retrieves the envelope notification, reminders, and expirations, information for an existing template

X

Retrieves pages of a document with given ID

X

Retrieves the list of templates for the specified account

X

User groups: Group brands

Retrieves information about the brands associated with the requested group

X

User groups: Groups

Retrieves information about groups associated with the account

X

User groups: Group users

Retrieves a list of users in a group

X

Users: Contacts

Retrieves contact with given contact ID

X

Users: User custom settings

Retrieves a list of custom user settings for a single user

X

Users: User profiles

Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user

X

Users: Users

Retrieves the user information for the specified user

X

Retrieves the user profile picture for the specified user

X

Retrieves a list of the account settings and email notification information for the specified user

X

Retrieves the list of users for the specified account

X

Create

X

Delete

X

Update

X

Users: User signatures

Retrieves the structure of a single signature with a known signature name

X

Retrieves the specified initials image or signature image for the specified user

X

Retrieves the signature definitions for the specified user

X

Workspaces: Workspace items

Retrieves a workspace file (the binary)

X

Retrieves a workspace file as rasterized pages

X

Retrieves workspace folder contents, which can include sub folders and files

X

Workspaces: Workspaces

Retrieves properties about a workspace given a unique workspace ID

X

Gets information about the workspaces that have been created

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.