Articles in this section

Available Adobe Sign APIs

When you configure an export, import, or other type of flow step using the prebuilt Adobe Sign 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 Adobe Sign API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Accounts

Retrieve the information for an account

X

Create an Acrobat sign account under the partner channel

X

Upload logo for an account

X

Retrieve the logo data for an account

X

Remove the logo data for an account

X

Add a signing reason to the account

X

Return the signing reasons for the account

X

Update the settings

X

Retrieve all events for account

X

Search settings for an account

X

Return a signing reason for the account

X

Remove a signing reason from the account

X

Update a signing reason for the account

X

Agreements

Retrieve the current status of an agreement

X

Retrieve info of all pages of a combined PDF document for the documents associated with an agreement

X

Retrieve URL of all visible pages of all the documents associated with an agreement

X

Retrieve the IDs of the documents of an agreement identified by agreement ID

X

Retrieve image URLs of all visible pages of a document associated with an agreement

X

Retrieve image URLs of all visible pages of all the documents associated with an agreement

X

Retrieve the events information for an agreement

X

Retrieve details of form fields of an agreement

X

Retrieve the merge info stored with an agreement

X

Retrieve the latest note associated with an agreement

X

Retrieve information of members of the agreement

X

Retrieve the participant set of an agreement identified by agreement ID in the path

X

Retrieve the security options for a particular participant

X

Retrieve the reminders of an agreement, identified by agreement ID in the path

X

Retrieve a specific reminder associated with an agreement

X

Retrieve the URL for the eSign page for the current signer(s) of an agreement

X

Retrieve the agreement information related to the API caller

X

Retrieve agreements for the user

X

Retrieve data entered into the interactive form fields of the agreement

X

Create an agreement. sends it out for signatures, and returns the agreement ID in the response to the client

X

Add template fields to an agreement

X

Create a participant set to which the agreement is forwarded for taking appropriate action

X

Share an agreement with someone

X

Create a reminder on the specified participants of an agreement identified by agreement ID in the path

X

Set the merge info for an agreement

X

Update the visibility of an agreement

X

Update the participant set of an agreement identified by agreement ID in the path

X

Complete the vaulting process and update the agreement as vaulted

X

Update the participant set of an agreement identified by agreement ID in the path

X

Reject the agreement for a participant

X

Update the security options for a particular participant

X

Update an existing reminder for an agreement

X

Update the state of an agreement identified by agreement ID in the path

X

Update the latest note associated with an agreement

X

Delete all the documents of an agreement

X

Retrieve a single combined PDF document for the documents associated with an agreement

X

Retrieve information of shares of the agreement

X

Delete an agreement share.

X

Change sender for an agreement that has status of draft

X

Get the settings for the agreement

X

Retrieve the latest state view URL of agreement

X

Retrieve the audit trail of an agreement identified by agreement ID

X

Update the draft agreement or update the expiration of an existing in progress agreement.

X

Generate URL or access code for each participant of an agreement

X

Retrieve the signer identity report of an agreement identified by agreement ID

X

Retrieve the file stream of a document of an agreement

X

Create a mobile focus specification for agreements

X

Update form fields of an agreement

X

Base URIs

Get the base URI to access other APIs in case other APIs are accessed from a different end point, it will be considered an invalid request

X

Electronic seals

Retrieve electronic seal configuration information

X

Retrieve all available electronic seals that can be used by the caller

X

Groups

Retrieve all the groups in an account

X

Retrieve detailed information about the group

X

Retrieve all the users in a group

X

Retrieve all events for group

X

Create a new group in an account

X

Update an existing group

X

Delete an existing group

X

Library documents

Retrieve library documents for a user

X

Retrieve the details of a library document

X

Retrieve URL of all visible pages of all the documents associated with a library document

X

Retrieve the IDs of the documents associated with library document

X

Retrieve data entered into the interactive form fields of the library document

X

Retrieve details of form fields of a library document

X

Retrieve information of members (creator) of the library document

X

Retrieve the library document information related to the API caller

X

Retrieve the events information for a library document

X

Retrieve the latest note of a library document for the API user

X

Create a template that is placed in the library of the user for reuse

X

Update details of form fields of a library document

X

Update the latest note of a library document for the API user

X

Update the library document

X

Update the visibility of library document

X

Update the library document's state

X

Retrieve the latest state view URL of a library document

X

Retrieve the details of a library document

X

Retrieve the audit trail associated with a library document

X

Retrieve the file stream of a document of library document

X

Retrieve image URLs of all visible pages of a document associated with a library document

X

Retrieve the details of a library document

X

Update library document sharing

X

Retrieve the combined document associated with a library document

X

Mega Sign

Get detailed information of the specified Mega Sign parent agreement

X

Retrieve URL of all visible pages of all the documents associated with the Mega Sign parent agreement

X

Retrieve the events information for the Mega Sign parent agreement

X

Retrieve detailed member info along with IDs for different types of participants associated with the Mega Sign parent agreement

X

Retrieve the latest note of a Mega Sign parent agreement for the user

X

Retrieve image URLs of all visible pages of a document associated with a Mega Sign parent agreement

X

Retrieve the IDs of the documents associated with a Mega Sign parent agreement

X

Retrieve the Mega Sign parent agreement information related to the API caller

X

Retrieve the reminders of the specified Mega Sign parent agreement

X

Retrieve a specific reminder given the reminder ID for the specified Mega Sign parent agreement

X

Retrieve send in bulk parent agreements for a user

X

Get all the child agreements of the specified send in bulk parent agreement

X

Retrieve data entered by recipients into interactive form fields at the time they signed the child agreements of the specified send in bulk agreement

X

Send an agreement out for signature to multiple recipients. each recipient will receive and sign their own copy of the agreement

X

Share a Mega Sign parent and all the child agreements with someone

X

Create a reminder on the specified participants of the Mega Sign parent

X

Update the expiration time on an existing Mega Sign parent and all the child agreements that are already out for signature

X

Update an existing reminder for a Mega Sign parent agreement

X

Update the latest MegaSigns note of a Mega Sign parent agreement for the user

X

Update the state of a Mega Sign identified by Mega Sign ID in the path

X

Update the visibility of a Mega Sign

X

Retrieve a single combined PDF document for the documents associated with the send in bulk parent agreement

X

Update the state of a bulk send identified by Mega Sign ID in the path

X

Retrieve the requested views of a bulk send agreement

X

Retrieve the file stream of the original child agreements info file that was uploaded by sender while creating the send in bulk

X

Retrieve a report of errors that occurred during creation of the provided Mega Sign child agreements

X

Retrieve details of form fields of a send in bulk parent agreement

X

Update the details of form fields of a send in bulk parent agreement

X

Retrieve the file stream of a document of a send in bulk parent agreement

X

Message templates

Retrieve a list of message templates applicable to the current user

X

Recipient groups

Retrieve the current state of a recipient group

X

Search

Retrieve, search, filter, and sorts agreements for the user

X

Transient documents

Retrieve the requested views for a transient document

X

Upload a document and obtains the document's ID

X

Users

Retrieve all the users in an account

X

Retrieve detailed information about the user in the caller account

X

Retrieve the groups of the user

X

Update a user

X

Update the groups of the user

X

Activate/deactivate a given user

X

Retrieve all events for user

X

Update the user locale

X

Retrieve the URL of manage, account settings, and user profile page

X

Create a new user in the Acrobat Sign system

X

Webhooks

Retrieve webhooks for a user

X

Retrieve the details of a webhook

X

Create a webhook

X

Update a webhook

X

Update the state of a webhook identified by webhook ID in the path

X

Delete a webhook

X

Create a webhook

X

Widgets

Retrieve image URLs of all visible pages of a document associated with a web form

X

Retrieve the details of a web form

X

Update a web form

X

Retrieve data entered by the user into interactive form fields at the time they signed the web form

X

Retrieve detailed member info along with IDs for different types of participants

X

Retrieve agreements for the web form

X

Retrieve the audit trail of a web form identified by widget ID

X

Share a web form with someone

X

Retrieve a single combined PDF document for the documents associated with a web form

X

Retrieve the participant set of a web form identified by widget ID in the path

X

Update the email of participant set of a web form identified by widget ID in the path

X

Update the email of CC participant of a web form identified by widget ID in the path

X

Update the visibility of web form

X

Update the state of a web form identified by widget ID in the path

X

Retrieve the web form information related to the API caller

X

Retrieve the security options for a particular participant

X

Update the security options for a particular participant

X

Create a web form and returns the widget ID in the response to the client

X

Retrieve web forms for a user

X

Retrieve the latest note of a web form for the API user

X

Update the latest note of a web form for the API user

X

Retrieve the events information for a web form

X

Retrieve URL of all visible pages of all the documents associated with a web form

X

Retrieve form fields for a web form

X

Update details of form fields of a web form

X

Retrieve the IDs of the documents associated with web form

X

Retrieve the requested views for a web form

X

Retrieve the file stream of a document of a web form

X

Workflows

Retrieve workflows for a user

X

Retrieve the details of a workflow

X