Qodex.ai
Qodex.ai
Introduction
Docusign Admin API
Authentication
03 Refresh Access Token04 Get User Info
BulkOperations
Returns a list of existing User List Exports (requests and completed exports) and their details/metadataCreates a new User List Export request.Returns the details/metadata for Account Setting Export requestsCreates a new Account Setting Export request.Returns the details/metadata for a single User List Export requestDeletes a single User List Export requestReturns the details/metadata for a single Account Setting Export requestDeletes a single Account Settings Export requestReturns the details/metadata for Bulk Account Settings Import requests in the organizationCreates a new account settings import request.Returns the details/metadata for a Bulk Account Settings Import requestDeletes a Bulk Account Settings Import requestImport request for adding users to accounts within the organization.Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId columnImport request for updating users to accounts within the organization.Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId columnCloses the Bulk User Import requestCloses memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organizationReturns the details/metadata for Bulk User Import requests in the organizationReturns the details/metadata for a User Import requestDeletes a User Import requestReturns a text/csv file with user details for a User Import request
IdentityProviders
Returns the list of identity providers for the organization.
Organization
Returns the list of organizations of which the authenticated user is a member.Returns the list of permission profiles in an account.Returns the list of groups in an account.
ReservedDomains
Returns the list of reserved domains for the organization.
UserManagement
Closes a user's memberships.Returns information about the users in the organizationCreates a new userActivates user membershipsReturns user information.Deletes user identities.Adds users to an account.Get list of DSGroupsAdd a new DSGroupGet list of DSGroupDelete a DSGroupGet list of users in a DSGroupAdd list of users to a DSGroupRemove users from a DSGroupGet products associated with the account and the available permission profilesRetrieve list of user's permission profiles for each account's productAssign user to permission profiles for one or more productsCreates and updates a multi-product userUpdates a user.Updates a user's email address.
Docusign Click API
Accounts
Provides base service and version access information.Gets the Clickwraps for an accountCreates a Clickwrap for the specified accountIdDeletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds. It will not delete active clickwraps.Gets the clickwrap for an account specified by clickwrapIdUpdates the clickwrap specified by clickwrapIdDeletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deletedChecks if a user has agreed to a clickwrap and returns a response with the agreement url. Returns HttpStatusCode.OK if user has no pending agreement.GET UndefinedGET DownloadGets the Clickwraps for an accountCreates the clickwrap versionDeletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified. It will not delete if a version is active.Gets the Clickwrap version by clickwrapId and versionId for an accountUpdates the clickwrap version specified by versionIdDelete a Clickwrap version specified by versionIdGets the Clickwrap version by clickwrapId and versionNumber for an accountUpdates the clickwrap version specified by versionNumber. Use versionId instead of versionNumberDelete a Clickwrap version specified by versionNumber. Use versionId instead of versionNumberGets the agreement responses for a clickwrap versionGET UndefinedGET Download
Authentication
03 Refresh Access Token04 Get User Info
Examples
20. Send an Envelope Using CompositeTemplates3. Get Envelope Status4. Envelope Recipients5. Add Tab to Envelope6. Get Tabs in an Envelope7. Add an Attachment to Envelope8. List Attachments in an Envelope9. Lists the Documents in an Envelope10. Get a Document from Envelope11. Lock the Envelope13. Delete Existing Lock on an Envelope14. Created Embedded View19. Create a Template with Role Only16. Get Account Templates17. Get Template Definition
Gets the agreement responses for a clickwrap version
Docusign Maestro API
Authentication
03 Refresh Access Token04 Get User Info
Creates a new workflow instance after authenticating with DS Account ServerCancels a running workflow instance.Get List of Step HistoriesGet Workflow Definitions metadataCreates a new workflow definition.Get Workflow DefinitionUpdates a workflow definition.Deletes a workflow definition.Gets configuration instancesGet List of Workflow InstancesGet Workflow Instance DetailsPublishes or unpublishes a workflow definition.
Docusign Rooms API
Accounts
Get information about the account.
Documents
Get information about the Document with the given DocumentId.Deletes a document.Grants access to a document for a user.
ESignPermissionProfiles
Gets permission profiles from the associated eSign account.
Forms
Creates an external form fill session.Get account Form Groups.Creates a form group.Gets a form group.Renames a form group.Deletes a form group.Removes a form from a form group.Assigns a form to a form group.Assign office to a form group so the specified office has access to the form group.Remove office to a form group so the specified office doesn't have access to the form group.Gets a paged list of forms libraries.Gets a paged list of forms in a forms library.Gets form based on Id.
Fields
Get details of a specific field set.
GlobalResources
Retrieves the list of valid countries.Retrieves the list of valid closing statuses.Retrieves the list of valid contact sides.Retrieves the list of valid financing types.Retrieves the list of valid origins of leads.Retrieves the list of valid property types.Retrieves the list of valid room contact types.Retrieves the list of valid seller decision types.Retrieves the list of valid special circumstance types.Retrieves the list of valid task date types.Retrieves the list of valid task responsibility types.Retrieves the list of valid task statuses.Retrieves the list of valid transaction sides.Retrieves the list of valid states.Retrieves the list of valid currencies.Retrieves the list of valid time zones.
Offices
Get all Create an office.Get information about the office with the given officeId.Delete an office.Lists the number of objects of each type that reference the office.
Regions
Get account Creates a new region for a companyGet information about the region with the given regionIdDelete a region.Get region reference counts.
Roles
Gets a paged-list of roles in your companyCreates a role.Get information about the role with the given roleId.Updates the role with the given roleId.Deletes the role with the given roleId.
Rooms
Returns the FieldData associated with the provided roomId.Updates room field data.Gets room folders accessible to the calling user.Adds a DocuSign Form to a roomRetrieves the list of users in the given Invites a user to the room by email address.Updates the specified user's role and transaction side.Revokes the specified user's access to the Restores the specified user's access to the Gets rooms available to the calling user.Creates a new RoomGets information about the given Deletes the room having the given room ID.Returns the roles for which the calling user, based on their role within the room, can assign to invitees.Get documents in the room accessible to the calling user.Add a document to a Add a document to a room via file contents upload.Update the picture for a Gets the field set associated with the
TaskLists
Returns the summary for all viewable task lists in a Add a task list to a room based on a task list template.Deletes a task list. If there are attached documents they will remain in the associated Returns all task list templates for the company of the active user.
RoomTemplates
Returns all room templates that the active user has access to
Users
Gets a paged-list of Retrieves user information for the user having the given UserId.Updates user informationRemoves a user from the company.NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.Reinvites the pending user with the given userId.Adds the user to the designated office.Removes the user from the designated office.Adds the user to the designated region.Removes the user from the designated region.Locks the account of the user.Unlocks the account of the user.
Authentication
03 Refresh Access Token04 Get User Info
Docusign Web Forms API
Authentication
03 Refresh Access Token04 Get User Info
WebForms
List FormsGet FormList instancesCreates an instance of the web formGet form instanceRefreshes the instance token
Docusign eSignature REST API
Diagnostics
Retrieves the available REST API versions.Gets the API request logging log files.Deletes the request log files.Gets a request logging log file.Gets the API request logging settings.Enables or disables API request logging for troubleshooting.
Accounts
Creates new accounts.Retrieves the account information for the specified account.Deletes the specified account.Gets list of recurring and usage charges for the account.Gets a list of brand profiles.Creates one or more brand profile files for the account.Deletes one or more brand profiles.Get information for a specific brand.Updates an existing brand.Removes a brand.Export a specific brand.Obtains the specified image for a brand.Put one branding logo.Delete one branding logo.Returns the specified account's list of branding resources (metadata).Returns the specified branding resource file.Uploads a branding resource file.Deletes the signature for one or more captive recipient records.Gets the Electronic Record and Signature Disclosure for the account.Gets the Electronic Record and Signature Disclosure.Update Consumer Disclosure.Gets a list of custom fields associated with the account.Creates an acount custom field.Updates an existing account custom field.Delete an existing account custom field.Retrieves the list of favorited templates for this callerFavorites a templateUnfavorite a templateGet the list of identity verification options for an accountGets a list of permission profiles.Creates a new permission profile in the specified account.Returns a permissions profile in the specified account.Updates a permission profile within the specified account.Deletes a permissions profile within the specified account.Gets recipient names associated with an email address.Returns Account available seals for specified account.Gets account settings information.Updates the account settings for an account.Returns the configuration information for the eNote eOriginal integration.Updates configuration information for the eNote eOriginal integration.Deletes configuration information for the eNote eOriginal integration.Select envelope purge configuration.Updates envelope purge configuration.Returns default user level settings for a specified accountUpdates default user level settings for a specified accountGet the password rulesUpdate the password rulesReturns tab settings list for specified accountModifies tab settings for specified accountReserved: Gets the shared item status for one or more users.Reserved: Sets the shared access information for users.Returns Account available signature providers for specified account.Returns the managed signature definitions for the accountUpdates a account signature.Adds/updates one or more account signatures. This request may include images in multi-part format.Returns information about a single signature by specifed signatureId.Updates a account signature.Close the specified signature by Id.Returns a signature, initials, or stamps image.Sets a signature, initials, or stamps image.Deletes a signature, initials, or stamps image.Gets list of supported languages for recipient language setting.Gets a list of unsupported file types.Creates the user authorizationReturns the user authorization for a given authorization idUpdates the user authorizationDeletes the user authorizationReturns the principal user authorizationsCreates ot updates user authorizationsCreates ot updates user authorizationsReturns the agent user authorizationsGet watermark information.Update watermark information.Get watermark preview.Retrieves the account provisioning information for the account.Get membership account password rulesGets the descriptors for all of an account's active reports (for listings)Creates a customized reportGets the specified reportSaves a customized reportRemoves a customized reportReturns the result set from running the specified reportReturns the specified report as a CSV string
Billing
Get a List of Billing InvoicesRetrieves a billing invoice.Get a list of past due invoices.Gets payment information for one or more payments.Posts a payment to a past due invoice.Gets billing payment information for a specific payment.Get Account Billing PlanUpdates the account billing plan.Get metadata for a given credit card.Returns downgrade plan information for the specified account.Queues downgrade billing plan request for an account.Reserverd: Purchase additional envelopes.Gets the list of available billing plans.Get the billing plan details.
BulkEnvelopes
Returns a list of bulk send batch satuses initiated by account.Gets a specific bulk send batch statusPut/Update a specific bulk send batch statusInitiate a specific bulk send batch actionGets envelopes from a specific bulk send batchLists top-level details for all bulk send lists visible to the current userCreates a new bulk send listGets a specific bulk send listUpdates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelopeDeletes an existing bulk send listUses the specified bulk send list to send the envelope specified in the payloadTests whether the specified bulk sending list can be used to send an envelope
Envelopes
Initiate a new ChunkedUpload.Retrieves the current metadata of a ChunkedUpload.Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.Delete an existing ChunkedUpload.Add a chunk, a chunk 'part', to an existing ChunkedUpload.Submits a batch of historical envelopes for republish to an adhoc config.Gets status changes for one or more envelopes.Creates an envelope.Gets the status of a envelope.Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draftReturns a list of attachments associated with the specified envelopeAdd one or more attachments to a DRAFT or IN-PROCESS envelope.Delete one or more attachments from a DRAFT envelope.Retrieves an attachment from the envelope.Add an attachment to a DRAFT or IN-PROCESS envelope.Gets the envelope audit events for an envelope.Gets comment transcript for envelope and userGets the custom field information for the specified envelope.Updates envelope custom fields in an envelope.Updates envelope custom fields for an envelope.Deletes envelope custom fields for draft and in-process envelopes.Returns formfields for an envelopeUpdates formfields for an envelopeGets a list of envelope documents.Adds one or more documents to an existing envelope document.Deletes documents from a draft envelope.Gets a document from an envelope.Adds a document to an existing draft envelope.Gets the custom document fields from an existing envelope document.Updates existing custom document fields in an existing envelope document.Creates custom document fields in an existing envelope document.Deletes custom document fields from an existing envelope document.Get the Original HTML Definition used to generate the Responsive HTML for a given document.Returns document page image(s) based on input.Deletes a page from a document in an envelope.Gets a page image from an envelope for display.Rotates page image from an envelope for display.Returns tabs on the specified page.Get Responsive HTML Preview for a document in an envelope.Returns tabs on the document.Updates the tabs for an envelope documentAdds the tabs to an envelope documentDeletes tabs from an envelope documentGets the templates associated with a document in an existing envelope.Adds templates to a document in an envelope.Deletes a template from a document in an existing envelope.Gets the email setting overrides for an envelope.Updates the email setting overrides for an envelope.Adds email setting overrides to an envelope.Deletes the email setting overrides for an envelope.Returns envelope form data for an existing envelope.Get the Original HTML Definition used to generate the Responsive HTML for the envelope.Gets envelope lock information.Updates an envelope lock.Lock an envelope.Deletes an envelope lock.Gets envelope notification information.Sets envelope notification (Reminders/Expirations) structure for an existing envelope.Gets the status of recipients for an envelope.Updates recipients in a draft envelope or corrects recipient information for an in process envelope.Adds one or more recipients to an envelope.Deletes recipients from an envelope.Deletes a recipient from an envelope.Gets the Electronic Record and Signature Disclosure associated with the account.Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.Returns document visibility for the recipientsUpdates document visibility for the recipientsReturns a resource token to get access to the identity events stored in the proof service related to this recipient.Gets the initials image for a user.Sets the initials image for an accountless signer.Gets signature information for a signer or sign-in-person recipient.Retrieve signature image information for a signer/sign-in-person recipient.Sets the signature image for an accountless signer.Gets the tabs information for a signer or sign-in-person recipient in an envelope.Updates the tabs for a recipient. Adds tabs for a recipient.Deletes the tabs associated with a recipient.Provides a link to access the Identity manual review related to a recipient.Updates document visibility for the recipientsGet Responsive HTML Preview for all documents in an envelope.Get encrypted tabs for envelope.Update encrypted tabs for envelope.Get List of Templates used in an EnvelopeAdds templates to an envelope.Returns a URL to the envelope correction UI.Revokes the correction view URL to the Envelope UIReturns a URL to the edit view UI.Returns a URL to the recipient view UI.Provides a URL to start a recipient view of the Envelope UIReturns a URL to the sender view UI.Provides a URL to start a shared recipient view of the Envelope UIReturns the workflow definition for an envelope.Updates the envelope workflow definition for an envelope.Delete the workflow definition for an envelope.Returns the scheduled sending rules for an envelope's workflow definition.Updates the scheduled sending rules for an envelope's workflow definition.Deletes the scheduled sending rules for the envelope's workflow.Creates and adds a new workflow step definition for an envelope's workflowReturns the workflow step definition for an envelope by step id.Updates the envelope workflow step definition for an envelope.Deletes the envelope workflow step definition for an envelope's workflow by step id.Returns the delayed routing rules for an envelope's workflow step definition.Updates the delayed routing rules for an envelope's workflow step definition.Deletes the delayed routing rules for the specified envelope workflow step.Gets the envelope status for the specified envelopes.Returns a list of envelope transfer rules in the specified account.Update envelope transfer rules for an account.Add envelope transfer rules to an account.Update an envelope transfer rule for an account.Delete envelope transfer rules for an account.Returns the workflow definition for a template.Updates the workflow definition for a template.Delete the workflow definition for a template.Returns the scheduled sending rules for a template's workflow definition.Updates the scheduled sending rules for a template's workflow definition.Deletes the scheduled sending rules for the template's workflow.Creates and adds a new workflow step definition for a template's workflowReturns the workflow step definition for a template by step id.Updates the template workflow step definition for an envelope.Deletes the workflow step definition for an template's workflow by step id.Returns the delayed routing rules for a template's workflow step definition.Updates the delayed routing rules for a template's workflow step definition.Deletes the delayed routing rules for the specified template workflow step.Returns a URL to the authentication view UI.Get notary jurisdictions for a user
Connect
Get Connect Configuration InformationUpdates a specified Connect configuration.Creates a connect configuration for the specified account.Get a Connect Configuration InformationDeletes the specified connect configuration.Returns all users from the configured Connect service.Returns users from the configured Connect service.Republishes Connect information for the specified envelope.Republishes Connect information for multiple envelopes.Gets the Connect failure log information.Deletes a Connect failure log entry.Gets the Connect log.Gets a list of Connect log entries.Get the specified Connect log entry.Deletes a specified Connect log entry.Sets the Connect OAuth Config for the account.Updates the existing Connect OAuth Config for the account.Sets the Connect OAuth Config for the account.Sets the Connect OAuth Config for the account.
Users
Replaces contacts associated with an account for the DocuSign service.Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).Delete contacts associated with an account for the DocuSign service.Gets a particular contact associated with the user's account.Replaces a particular contact associated with an account for the DocuSign service.Provides a URL to start an edit view of the Template UIRetrieves the list of users for the specified account.Change one or more user in the specified account.Adds news user to the specified account.Removes users account privileges.Gets the user information for a specified user.Updates the specified user information.Retrieves the custom user settings for a specified user.Adds or updates custom user settings for the specified user.Deletes custom user settings for a specified user.Retrieves the user profile for a specified user.Updates the user profile information for the specified user.Retrieves the user profile image for the specified user.Updates the user profile image for a specified user.Deletes the user profile image for the specified user.Gets the user account settings for a specified user.Updates the user account settings for a specified user.Retrieves a list of user signature definitions for a specified user.Adds/updates a user signature.Adds user Signature and initials images to a Signature.Gets the user signature information for the specified user.Updates the user signature for a specified user.Removes removes signature information for the specified user.Retrieves the user initials image or the user signature image for the specified user.Updates the user signature image or user initials image for the specified user.Deletes the user initials image or the user signature image for the specified user.
Folders
Gets a list of the folders for the account.Gets a list of the envelopes in the specified folder.Moves an envelope from its current folder to the specified folder.Gets a list of envelopes in folders matching the specified criteria.
UserGroups
Gets information about groups associated with the account.Updates the group information for a group.Creates one or more groups for the account.Deletes an existing user group.Gets group brand ID Information. Adds group brand ID information to a group.Deletes brand information from the requested group.Gets a list of users in a group.Adds one or more users to an existing group.Deletes one or more users from a gro
Payments
Get all payment gateway account for the provided accountId
PowerForms
Returns the list of PowerForms available to the user.Creates a new PowerForm.Deletes one or more PowerFormsReturns a single PowerForm.Creates a new PowerForm.Delete a PowerForm.Returns the form data associated with the usage of a PowerForm.Returns the list of PowerForms available to the user.
EmailArchive
Get the blind carbon copy email archive entries owned by the specified accountCreates a blind carbon copy email archive entryGet the blind carbon copy email archive history entries for the specified archiveDelete a blind carbon copy email archive for an account.
SigningGroups
Gets a list of the Signing Groups in an account.Updates signing group names.Creates a signing group. Deletes one or more signing groups.Gets information about a signing group. Updates a signing group. Gets a list of members in a Signing Group.Adds members to a signing group. Deletes one or more members from a signing group.
CustomTabs
Gets a list of all account tabs.Creates a custom tab.Gets custom tab information.Updates custom tab information. Deletes custom tab information.
Templates
Gets the definition of a template.Creates an envelope from a template.Gets a list of templates for a specified account.Updates an existing template.Shares a template with a groupRemoves a member group's sharing permissions for a template.Gets the custom document fields from a template.Updates envelope custom fields in a template.Creates custom document fields in an existing template document.Deletes envelope custom fields in a template.Gets a list of documents associated with a template.Adds documents to a template document.Deletes documents from a template.Gets PDF documents from a template.Adds a document to a template document.Gets the custom document fields for a an existing template document.Updates existing custom document fields in an existing template document.Creates custom document fields in an existing template document.Deletes custom document fields from an existing template document.Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.Deletes a page from a document in an template.Gets a page image from a template for display.Rotates page image from a template for display.Returns tabs on the specified page.Post Responsive HTML Preview for a document in a template.Returns tabs on the document.Updates the tabs for a templateAdds the tabs to a tempateDeletes tabs from an envelope documentGet the Original HTML Definition used to generate the Responsive HTML for the template.Gets template lock information.Updates a template lock.Lock a template.Deletes a template lock.Gets template notification information.Updates the notification structure for an existing template.Gets recipient information from a template.Updates recipients in a template.Adds tabs for a recipient.Deletes recipients from a template.Deletes the specified recipient file from a template.Returns document visibility for the recipientsUpdates document visibility for the recipientsGets the tabs information for a signer or sign-in-person recipient in a template.Updates the tabs for a recipient.Adds tabs for a recipient.Deletes the tabs associated with a recipient in a template.Updates document visibility for the recipientsGet Responsive HTML Preview for all documents in a template.Provides a URL to start a recipient view of the Envelope UIGets the bulk recipient file from a template.Adds or replaces the bulk recipients list in a template.Deletes the bulk recipient list on a template.Returns document page image(s) based on input.
CloudStorage
Get the Cloud Storage Provider configuration for the specified user.Configures the redirect URL information for one or more cloud storage providers for the specified user.Deletes the user authentication information for one or more cloud storage providers.Gets the specified Cloud Storage Provider configuration for the User.Deletes the user authentication information for the specified cloud storage provider.Retrieves a list of all the items in a specified folder from the specified cloud storage provider.Gets a list of all the items from the specified cloud storage provider.
Workspaces
List WorkspacesCreate a WorkspaceGet WorkspaceUpdate WorkspaceDelete WorkspaceList Workspace Folder ContentsDeletes workspace one or more specific files/folders from the given folder or root.Creates a workspace file.Get Workspace FileUpdate Workspace File MetadataList File Pages
Notary
Get notary settings for a userUpdate a notaryAdd a notary to the systemGet notary jurisdictions for a userAdd a notary jurisdiction to the systemGet notary a jurisdiction for a userUpdate a notary jurisdictionDelete a notary jurisdiction a specified user.
Authentication
03 Refresh Access Token04 Get User Info
Examples
20. Send an Envelope Using CompositeTemplates3. Get Envelope Status4. Envelope Recipients5. Add Tab to Envelope6. Get Tabs in an Envelope7. Add an Attachment to Envelope8. List Attachments in an Envelope9. Lists the Documents in an Envelope10. Get a Document from Envelope11. Lock the Envelope12. Lists the Existing Locks on an Envelope14. Created Embedded View19. Create a Template with Role Only16. Get Account Templates17. Get Template Definition13. Delete Existing Lock on an Envelope
Lists resources for REST version specifiedReturns document page image(s) based on input.Returns a signature, initials, or stamps image.Sets a signature, initials, or stamps image.Deletes a signature, initials, or stamps image.
Introduction
Docusign Admin API
Authentication
03 Refresh Access Token04 Get User Info
BulkOperations
Returns a list of existing User List Exports (requests and completed exports) and their details/metadataCreates a new User List Export request.Returns the details/metadata for Account Setting Export requestsCreates a new Account Setting Export request.Returns the details/metadata for a single User List Export requestDeletes a single User List Export requestReturns the details/metadata for a single Account Setting Export requestDeletes a single Account Settings Export requestReturns the details/metadata for Bulk Account Settings Import requests in the organizationCreates a new account settings import request.Returns the details/metadata for a Bulk Account Settings Import requestDeletes a Bulk Account Settings Import requestImport request for adding users to accounts within the organization.Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId columnImport request for updating users to accounts within the organization.Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId columnCloses the Bulk User Import requestCloses memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organizationReturns the details/metadata for Bulk User Import requests in the organizationReturns the details/metadata for a User Import requestDeletes a User Import requestReturns a text/csv file with user details for a User Import request
IdentityProviders
Returns the list of identity providers for the organization.
Organization
Returns the list of organizations of which the authenticated user is a member.Returns the list of permission profiles in an account.Returns the list of groups in an account.
ReservedDomains
Returns the list of reserved domains for the organization.
UserManagement
Closes a user's memberships.Returns information about the users in the organizationCreates a new userActivates user membershipsReturns user information.Deletes user identities.Adds users to an account.Get list of DSGroupsAdd a new DSGroupGet list of DSGroupDelete a DSGroupGet list of users in a DSGroupAdd list of users to a DSGroupRemove users from a DSGroupGet products associated with the account and the available permission profilesRetrieve list of user's permission profiles for each account's productAssign user to permission profiles for one or more productsCreates and updates a multi-product userUpdates a user.Updates a user's email address.
Docusign Click API
Accounts
Provides base service and version access information.Gets the Clickwraps for an accountCreates a Clickwrap for the specified accountIdDeletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds. It will not delete active clickwraps.Gets the clickwrap for an account specified by clickwrapIdUpdates the clickwrap specified by clickwrapIdDeletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deletedChecks if a user has agreed to a clickwrap and returns a response with the agreement url. Returns HttpStatusCode.OK if user has no pending agreement.GET UndefinedGET DownloadGets the Clickwraps for an accountCreates the clickwrap versionDeletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified. It will not delete if a version is active.Gets the Clickwrap version by clickwrapId and versionId for an accountUpdates the clickwrap version specified by versionIdDelete a Clickwrap version specified by versionIdGets the Clickwrap version by clickwrapId and versionNumber for an accountUpdates the clickwrap version specified by versionNumber. Use versionId instead of versionNumberDelete a Clickwrap version specified by versionNumber. Use versionId instead of versionNumberGets the agreement responses for a clickwrap versionGET UndefinedGET Download
Authentication
03 Refresh Access Token04 Get User Info
Examples
20. Send an Envelope Using CompositeTemplates3. Get Envelope Status4. Envelope Recipients5. Add Tab to Envelope6. Get Tabs in an Envelope7. Add an Attachment to Envelope8. List Attachments in an Envelope9. Lists the Documents in an Envelope10. Get a Document from Envelope11. Lock the Envelope13. Delete Existing Lock on an Envelope14. Created Embedded View19. Create a Template with Role Only16. Get Account Templates17. Get Template Definition
Gets the agreement responses for a clickwrap version
Docusign Maestro API
Authentication
03 Refresh Access Token04 Get User Info
Creates a new workflow instance after authenticating with DS Account ServerCancels a running workflow instance.Get List of Step HistoriesGet Workflow Definitions metadataCreates a new workflow definition.Get Workflow DefinitionUpdates a workflow definition.Deletes a workflow definition.Gets configuration instancesGet List of Workflow InstancesGet Workflow Instance DetailsPublishes or unpublishes a workflow definition.
Docusign Rooms API
Accounts
Get information about the account.
Documents
Get information about the Document with the given DocumentId.Deletes a document.Grants access to a document for a user.
ESignPermissionProfiles
Gets permission profiles from the associated eSign account.
Forms
Creates an external form fill session.Get account Form Groups.Creates a form group.Gets a form group.Renames a form group.Deletes a form group.Removes a form from a form group.Assigns a form to a form group.Assign office to a form group so the specified office has access to the form group.Remove office to a form group so the specified office doesn't have access to the form group.Gets a paged list of forms libraries.Gets a paged list of forms in a forms library.Gets form based on Id.
Fields
Get details of a specific field set.
GlobalResources
Retrieves the list of valid countries.Retrieves the list of valid closing statuses.Retrieves the list of valid contact sides.Retrieves the list of valid financing types.Retrieves the list of valid origins of leads.Retrieves the list of valid property types.Retrieves the list of valid room contact types.Retrieves the list of valid seller decision types.Retrieves the list of valid special circumstance types.Retrieves the list of valid task date types.Retrieves the list of valid task responsibility types.Retrieves the list of valid task statuses.Retrieves the list of valid transaction sides.Retrieves the list of valid states.Retrieves the list of valid currencies.Retrieves the list of valid time zones.
Offices
Get all Create an office.Get information about the office with the given officeId.Delete an office.Lists the number of objects of each type that reference the office.
Regions
Get account Creates a new region for a companyGet information about the region with the given regionIdDelete a region.Get region reference counts.
Roles
Gets a paged-list of roles in your companyCreates a role.Get information about the role with the given roleId.Updates the role with the given roleId.Deletes the role with the given roleId.
Rooms
Returns the FieldData associated with the provided roomId.Updates room field data.Gets room folders accessible to the calling user.Adds a DocuSign Form to a roomRetrieves the list of users in the given Invites a user to the room by email address.Updates the specified user's role and transaction side.Revokes the specified user's access to the Restores the specified user's access to the Gets rooms available to the calling user.Creates a new RoomGets information about the given Deletes the room having the given room ID.Returns the roles for which the calling user, based on their role within the room, can assign to invitees.Get documents in the room accessible to the calling user.Add a document to a Add a document to a room via file contents upload.Update the picture for a Gets the field set associated with the
TaskLists
Returns the summary for all viewable task lists in a Add a task list to a room based on a task list template.Deletes a task list. If there are attached documents they will remain in the associated Returns all task list templates for the company of the active user.
RoomTemplates
Returns all room templates that the active user has access to
Users
Gets a paged-list of Retrieves user information for the user having the given UserId.Updates user informationRemoves a user from the company.NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.Reinvites the pending user with the given userId.Adds the user to the designated office.Removes the user from the designated office.Adds the user to the designated region.Removes the user from the designated region.Locks the account of the user.Unlocks the account of the user.
Authentication
03 Refresh Access Token04 Get User Info
Docusign Web Forms API
Authentication
03 Refresh Access Token04 Get User Info
WebForms
List FormsGet FormList instancesCreates an instance of the web formGet form instanceRefreshes the instance token
Docusign eSignature REST API
Diagnostics
Retrieves the available REST API versions.Gets the API request logging log files.Deletes the request log files.Gets a request logging log file.Gets the API request logging settings.Enables or disables API request logging for troubleshooting.
Accounts
Creates new accounts.Retrieves the account information for the specified account.Deletes the specified account.Gets list of recurring and usage charges for the account.Gets a list of brand profiles.Creates one or more brand profile files for the account.Deletes one or more brand profiles.Get information for a specific brand.Updates an existing brand.Removes a brand.Export a specific brand.Obtains the specified image for a brand.Put one branding logo.Delete one branding logo.Returns the specified account's list of branding resources (metadata).Returns the specified branding resource file.Uploads a branding resource file.Deletes the signature for one or more captive recipient records.Gets the Electronic Record and Signature Disclosure for the account.Gets the Electronic Record and Signature Disclosure.Update Consumer Disclosure.Gets a list of custom fields associated with the account.Creates an acount custom field.Updates an existing account custom field.Delete an existing account custom field.Retrieves the list of favorited templates for this callerFavorites a templateUnfavorite a templateGet the list of identity verification options for an accountGets a list of permission profiles.Creates a new permission profile in the specified account.Returns a permissions profile in the specified account.Updates a permission profile within the specified account.Deletes a permissions profile within the specified account.Gets recipient names associated with an email address.Returns Account available seals for specified account.Gets account settings information.Updates the account settings for an account.Returns the configuration information for the eNote eOriginal integration.Updates configuration information for the eNote eOriginal integration.Deletes configuration information for the eNote eOriginal integration.Select envelope purge configuration.Updates envelope purge configuration.Returns default user level settings for a specified accountUpdates default user level settings for a specified accountGet the password rulesUpdate the password rulesReturns tab settings list for specified accountModifies tab settings for specified accountReserved: Gets the shared item status for one or more users.Reserved: Sets the shared access information for users.Returns Account available signature providers for specified account.Returns the managed signature definitions for the accountUpdates a account signature.Adds/updates one or more account signatures. This request may include images in multi-part format.Returns information about a single signature by specifed signatureId.Updates a account signature.Close the specified signature by Id.Returns a signature, initials, or stamps image.Sets a signature, initials, or stamps image.Deletes a signature, initials, or stamps image.Gets list of supported languages for recipient language setting.Gets a list of unsupported file types.Creates the user authorizationReturns the user authorization for a given authorization idUpdates the user authorizationDeletes the user authorizationReturns the principal user authorizationsCreates ot updates user authorizationsCreates ot updates user authorizationsReturns the agent user authorizationsGet watermark information.Update watermark information.Get watermark preview.Retrieves the account provisioning information for the account.Get membership account password rulesGets the descriptors for all of an account's active reports (for listings)Creates a customized reportGets the specified reportSaves a customized reportRemoves a customized reportReturns the result set from running the specified reportReturns the specified report as a CSV string
Billing
Get a List of Billing InvoicesRetrieves a billing invoice.Get a list of past due invoices.Gets payment information for one or more payments.Posts a payment to a past due invoice.Gets billing payment information for a specific payment.Get Account Billing PlanUpdates the account billing plan.Get metadata for a given credit card.Returns downgrade plan information for the specified account.Queues downgrade billing plan request for an account.Reserverd: Purchase additional envelopes.Gets the list of available billing plans.Get the billing plan details.
BulkEnvelopes
Returns a list of bulk send batch satuses initiated by account.Gets a specific bulk send batch statusPut/Update a specific bulk send batch statusInitiate a specific bulk send batch actionGets envelopes from a specific bulk send batchLists top-level details for all bulk send lists visible to the current userCreates a new bulk send listGets a specific bulk send listUpdates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelopeDeletes an existing bulk send listUses the specified bulk send list to send the envelope specified in the payloadTests whether the specified bulk sending list can be used to send an envelope
Envelopes
Initiate a new ChunkedUpload.Retrieves the current metadata of a ChunkedUpload.Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.Delete an existing ChunkedUpload.Add a chunk, a chunk 'part', to an existing ChunkedUpload.Submits a batch of historical envelopes for republish to an adhoc config.Gets status changes for one or more envelopes.Creates an envelope.Gets the status of a envelope.Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draftReturns a list of attachments associated with the specified envelopeAdd one or more attachments to a DRAFT or IN-PROCESS envelope.Delete one or more attachments from a DRAFT envelope.Retrieves an attachment from the envelope.Add an attachment to a DRAFT or IN-PROCESS envelope.Gets the envelope audit events for an envelope.Gets comment transcript for envelope and userGets the custom field information for the specified envelope.Updates envelope custom fields in an envelope.Updates envelope custom fields for an envelope.Deletes envelope custom fields for draft and in-process envelopes.Returns formfields for an envelopeUpdates formfields for an envelopeGets a list of envelope documents.Adds one or more documents to an existing envelope document.Deletes documents from a draft envelope.Gets a document from an envelope.Adds a document to an existing draft envelope.Gets the custom document fields from an existing envelope document.Updates existing custom document fields in an existing envelope document.Creates custom document fields in an existing envelope document.Deletes custom document fields from an existing envelope document.Get the Original HTML Definition used to generate the Responsive HTML for a given document.Returns document page image(s) based on input.Deletes a page from a document in an envelope.Gets a page image from an envelope for display.Rotates page image from an envelope for display.Returns tabs on the specified page.Get Responsive HTML Preview for a document in an envelope.Returns tabs on the document.Updates the tabs for an envelope documentAdds the tabs to an envelope documentDeletes tabs from an envelope documentGets the templates associated with a document in an existing envelope.Adds templates to a document in an envelope.Deletes a template from a document in an existing envelope.Gets the email setting overrides for an envelope.Updates the email setting overrides for an envelope.Adds email setting overrides to an envelope.Deletes the email setting overrides for an envelope.Returns envelope form data for an existing envelope.Get the Original HTML Definition used to generate the Responsive HTML for the envelope.Gets envelope lock information.Updates an envelope lock.Lock an envelope.Deletes an envelope lock.Gets envelope notification information.Sets envelope notification (Reminders/Expirations) structure for an existing envelope.Gets the status of recipients for an envelope.Updates recipients in a draft envelope or corrects recipient information for an in process envelope.Adds one or more recipients to an envelope.Deletes recipients from an envelope.Deletes a recipient from an envelope.Gets the Electronic Record and Signature Disclosure associated with the account.Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.Returns document visibility for the recipientsUpdates document visibility for the recipientsReturns a resource token to get access to the identity events stored in the proof service related to this recipient.Gets the initials image for a user.Sets the initials image for an accountless signer.Gets signature information for a signer or sign-in-person recipient.Retrieve signature image information for a signer/sign-in-person recipient.Sets the signature image for an accountless signer.Gets the tabs information for a signer or sign-in-person recipient in an envelope.Updates the tabs for a recipient. Adds tabs for a recipient.Deletes the tabs associated with a recipient.Provides a link to access the Identity manual review related to a recipient.Updates document visibility for the recipientsGet Responsive HTML Preview for all documents in an envelope.Get encrypted tabs for envelope.Update encrypted tabs for envelope.Get List of Templates used in an EnvelopeAdds templates to an envelope.Returns a URL to the envelope correction UI.Revokes the correction view URL to the Envelope UIReturns a URL to the edit view UI.Returns a URL to the recipient view UI.Provides a URL to start a recipient view of the Envelope UIReturns a URL to the sender view UI.Provides a URL to start a shared recipient view of the Envelope UIReturns the workflow definition for an envelope.Updates the envelope workflow definition for an envelope.Delete the workflow definition for an envelope.Returns the scheduled sending rules for an envelope's workflow definition.Updates the scheduled sending rules for an envelope's workflow definition.Deletes the scheduled sending rules for the envelope's workflow.Creates and adds a new workflow step definition for an envelope's workflowReturns the workflow step definition for an envelope by step id.Updates the envelope workflow step definition for an envelope.Deletes the envelope workflow step definition for an envelope's workflow by step id.Returns the delayed routing rules for an envelope's workflow step definition.Updates the delayed routing rules for an envelope's workflow step definition.Deletes the delayed routing rules for the specified envelope workflow step.Gets the envelope status for the specified envelopes.Returns a list of envelope transfer rules in the specified account.Update envelope transfer rules for an account.Add envelope transfer rules to an account.Update an envelope transfer rule for an account.Delete envelope transfer rules for an account.Returns the workflow definition for a template.Updates the workflow definition for a template.Delete the workflow definition for a template.Returns the scheduled sending rules for a template's workflow definition.Updates the scheduled sending rules for a template's workflow definition.Deletes the scheduled sending rules for the template's workflow.Creates and adds a new workflow step definition for a template's workflowReturns the workflow step definition for a template by step id.Updates the template workflow step definition for an envelope.Deletes the workflow step definition for an template's workflow by step id.Returns the delayed routing rules for a template's workflow step definition.Updates the delayed routing rules for a template's workflow step definition.Deletes the delayed routing rules for the specified template workflow step.Returns a URL to the authentication view UI.Get notary jurisdictions for a user
Connect
Get Connect Configuration InformationUpdates a specified Connect configuration.Creates a connect configuration for the specified account.Get a Connect Configuration InformationDeletes the specified connect configuration.Returns all users from the configured Connect service.Returns users from the configured Connect service.Republishes Connect information for the specified envelope.Republishes Connect information for multiple envelopes.Gets the Connect failure log information.Deletes a Connect failure log entry.Gets the Connect log.Gets a list of Connect log entries.Get the specified Connect log entry.Deletes a specified Connect log entry.Sets the Connect OAuth Config for the account.Updates the existing Connect OAuth Config for the account.Sets the Connect OAuth Config for the account.Sets the Connect OAuth Config for the account.
Users
Replaces contacts associated with an account for the DocuSign service.Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).Delete contacts associated with an account for the DocuSign service.Gets a particular contact associated with the user's account.Replaces a particular contact associated with an account for the DocuSign service.Provides a URL to start an edit view of the Template UIRetrieves the list of users for the specified account.Change one or more user in the specified account.Adds news user to the specified account.Removes users account privileges.Gets the user information for a specified user.Updates the specified user information.Retrieves the custom user settings for a specified user.Adds or updates custom user settings for the specified user.Deletes custom user settings for a specified user.Retrieves the user profile for a specified user.Updates the user profile information for the specified user.Retrieves the user profile image for the specified user.Updates the user profile image for a specified user.Deletes the user profile image for the specified user.Gets the user account settings for a specified user.Updates the user account settings for a specified user.Retrieves a list of user signature definitions for a specified user.Adds/updates a user signature.Adds user Signature and initials images to a Signature.Gets the user signature information for the specified user.Updates the user signature for a specified user.Removes removes signature information for the specified user.Retrieves the user initials image or the user signature image for the specified user.Updates the user signature image or user initials image for the specified user.Deletes the user initials image or the user signature image for the specified user.
Folders
Gets a list of the folders for the account.Gets a list of the envelopes in the specified folder.Moves an envelope from its current folder to the specified folder.Gets a list of envelopes in folders matching the specified criteria.
UserGroups
Gets information about groups associated with the account.Updates the group information for a group.Creates one or more groups for the account.Deletes an existing user group.Gets group brand ID Information. Adds group brand ID information to a group.Deletes brand information from the requested group.Gets a list of users in a group.Adds one or more users to an existing group.Deletes one or more users from a gro
Payments
Get all payment gateway account for the provided accountId
PowerForms
Returns the list of PowerForms available to the user.Creates a new PowerForm.Deletes one or more PowerFormsReturns a single PowerForm.Creates a new PowerForm.Delete a PowerForm.Returns the form data associated with the usage of a PowerForm.Returns the list of PowerForms available to the user.
EmailArchive
Get the blind carbon copy email archive entries owned by the specified accountCreates a blind carbon copy email archive entryGet the blind carbon copy email archive history entries for the specified archiveDelete a blind carbon copy email archive for an account.
SigningGroups
Gets a list of the Signing Groups in an account.Updates signing group names.Creates a signing group. Deletes one or more signing groups.Gets information about a signing group. Updates a signing group. Gets a list of members in a Signing Group.Adds members to a signing group. Deletes one or more members from a signing group.
CustomTabs
Gets a list of all account tabs.Creates a custom tab.Gets custom tab information.Updates custom tab information. Deletes custom tab information.
Templates
Gets the definition of a template.Creates an envelope from a template.Gets a list of templates for a specified account.Updates an existing template.Shares a template with a groupRemoves a member group's sharing permissions for a template.Gets the custom document fields from a template.Updates envelope custom fields in a template.Creates custom document fields in an existing template document.Deletes envelope custom fields in a template.Gets a list of documents associated with a template.Adds documents to a template document.Deletes documents from a template.Gets PDF documents from a template.Adds a document to a template document.Gets the custom document fields for a an existing template document.Updates existing custom document fields in an existing template document.Creates custom document fields in an existing template document.Deletes custom document fields from an existing template document.Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.Deletes a page from a document in an template.Gets a page image from a template for display.Rotates page image from a template for display.Returns tabs on the specified page.Post Responsive HTML Preview for a document in a template.Returns tabs on the document.Updates the tabs for a templateAdds the tabs to a tempateDeletes tabs from an envelope documentGet the Original HTML Definition used to generate the Responsive HTML for the template.Gets template lock information.Updates a template lock.Lock a template.Deletes a template lock.Gets template notification information.Updates the notification structure for an existing template.Gets recipient information from a template.Updates recipients in a template.Adds tabs for a recipient.Deletes recipients from a template.Deletes the specified recipient file from a template.Returns document visibility for the recipientsUpdates document visibility for the recipientsGets the tabs information for a signer or sign-in-person recipient in a template.Updates the tabs for a recipient.Adds tabs for a recipient.Deletes the tabs associated with a recipient in a template.Updates document visibility for the recipientsGet Responsive HTML Preview for all documents in a template.Provides a URL to start a recipient view of the Envelope UIGets the bulk recipient file from a template.Adds or replaces the bulk recipients list in a template.Deletes the bulk recipient list on a template.Returns document page image(s) based on input.
CloudStorage
Get the Cloud Storage Provider configuration for the specified user.Configures the redirect URL information for one or more cloud storage providers for the specified user.Deletes the user authentication information for one or more cloud storage providers.Gets the specified Cloud Storage Provider configuration for the User.Deletes the user authentication information for the specified cloud storage provider.Retrieves a list of all the items in a specified folder from the specified cloud storage provider.Gets a list of all the items from the specified cloud storage provider.
Workspaces
List WorkspacesCreate a WorkspaceGet WorkspaceUpdate WorkspaceDelete WorkspaceList Workspace Folder ContentsDeletes workspace one or more specific files/folders from the given folder or root.Creates a workspace file.Get Workspace FileUpdate Workspace File MetadataList File Pages
Notary
Get notary settings for a userUpdate a notaryAdd a notary to the systemGet notary jurisdictions for a userAdd a notary jurisdiction to the systemGet notary a jurisdiction for a userUpdate a notary jurisdictionDelete a notary jurisdiction a specified user.
Authentication
03 Refresh Access Token04 Get User Info
Examples
20. Send an Envelope Using CompositeTemplates3. Get Envelope Status4. Envelope Recipients5. Add Tab to Envelope6. Get Tabs in an Envelope7. Add an Attachment to Envelope8. List Attachments in an Envelope9. Lists the Documents in an Envelope10. Get a Document from Envelope11. Lock the Envelope12. Lists the Existing Locks on an Envelope14. Created Embedded View19. Create a Template with Role Only16. Get Account Templates17. Get Template Definition13. Delete Existing Lock on an Envelope
Lists resources for REST version specifiedReturns document page image(s) based on input.Returns a signature, initials, or stamps image.Sets a signature, initials, or stamps image.Deletes a signature, initials, or stamps image.
HomeDocusign eSignature REST APIAuthentication

Authentication

Number of APIs: 2

  1. 04 Get User Info GET https://{{hostenv}}/oauth/userinfo

  2. 03 Refresh Access Token POST https://{{hostenv}}/oauth/token

Previous
Delete a notary jurisdiction a specified user.
Next
03 Refresh Access Token