Adobe Acrobat Sign

App · E-Signatures · 20 actions

Send documents for e-signature with Adobe Acrobat Sign, track and remind signers, collect form data and signed PDFs, and manage library templates and web forms.

Actions

ActionWhat it does
Cancel Acrobat Sign agreementCancel an agreement that is still out for signature.
Create Acrobat Sign library templateSave a document to your library as a reusable template.
Create Acrobat Sign web formCreate a web form: a public page where anyone with the link can sign the document.
Get Acrobat Sign agreementGet an agreement's status, recipients and settings.
Get Acrobat Sign document download linkA short-lived link to download the agreement as one PDF - the signed copy once it is complete.
Get Acrobat Sign form dataThe values recipients entered into the agreement's fields, one row per participant.
Get Acrobat Sign signing linksGet the links the current signers use to sign, e.g. to send them yourself or embed them.
Get current Acrobat Sign userThe Acrobat Sign user this connection signs in as.
List Acrobat Sign agreement documentsList the documents in an agreement, and any supporting files recipients attached.
List Acrobat Sign agreement eventsThe agreement's audit trail: sent, viewed, signed, reminded and so on.
List Acrobat Sign agreement membersList an agreement's recipients, cc's and sender, with the participant ids Send reminder needs.
List Acrobat Sign agreementsList your agreements, most recent first.
List Acrobat Sign library templatesList the reusable templates in your library.
List Acrobat Sign usersList the users in your Acrobat Sign account.
List Acrobat Sign web formsList your web forms with their public links.
Search Acrobat Sign agreementsFind agreements by text, status, your role, participant or date.
Send Acrobat Sign agreementSend a document to one or more people to sign, approve or fill in.
Send Acrobat Sign reminderRemind recipients who have not acted yet.
Set Acrobat Sign agreement noteSet your private note on an agreement.
Upload document to Acrobat SignUpload a file, or plain text as a .txt document, for use in Send agreement, Create library template or Create web form.

Cancel Acrobat Sign agreement

Cancel an agreement that is still out for signature. Only its sender can cancel it.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.
Reasoncommenttext
Why it was cancelled.
Email the recipientsnotify_otherstrue/false
Tell the recipients it was cancelled.Default: false.

Outputs

idtext
statetext
Example output
{
  "id": "CBJCHBCAABAA-agreement",
  "state": "CANCELLED"
}

Create Acrobat Sign library template

Save a document to your library as a reusable template. Library templates cannot be deleted through the API.

Inputs

Template namenametextRequired
Name shown in your library.
Uploaded document IDtransient_document_idtext
The transient_document_id from Upload document (valid for 7 days). Give this or a file URL.
File URLfile_urltext
A public https link to the file. Acrobat Sign downloads it itself, so it must not need a sign-in.
File namefile_nametext
Name for the file from the link, with its extension (e.g. contract.pdf). Taken from the link when left blank.
Shared withsharing_modetext
Who else can use the template.One of: USER (Only me), GROUP (My group), ACCOUNT (Everyone in my account). Default: USER.
Template typetemplate_typeslist
A reusable document, a form field layer, or both.One or more of: DOCUMENT (Reusable document), FORM_FIELD_LAYER (Form field layer). Default: ["DOCUMENT"].
Statestatetext
Ready to use, or still being authored.One of: ACTIVE (Active (ready to use)), AUTHORING (Authoring (add fields in Acrobat Sign first)). Default: ACTIVE.

Outputs

idtext
nametext
sharing_modetext
statetext
Example output
{
  "id": "CBJCHBCAABAA-library",
  "name": "NDA",
  "sharing_mode": "USER",
  "state": "ACTIVE"
}

Create Acrobat Sign web form

Create a web form: a public page where anyone with the link can sign the document. Web forms cannot be deleted through the API.

Inputs

Web form namenametextRequired
Name shown to signers and in your list.
Uploaded document IDtransient_document_idtext
The transient_document_id from Upload document (valid for 7 days). Give this or a file URL.
File URLfile_urltext
A public https link to the file. Acrobat Sign downloads it itself, so it must not need a sign-in.
File namefile_nametext
Name for the file from the link, with its extension (e.g. contract.pdf). Taken from the link when left blank.
Signer's roleroletext
What the person opening the form is asked to do.One of: SIGNER, APPROVER, ACCEPTOR, FORM_FILLER (Form filler). Default: SIGNER.
Statestatetext
Live now, or saved as a draft.One of: ACTIVE (Active (live for anyone with the link)), DRAFT. Default: ACTIVE.
CCcc_emailslist
Email addresses to copy on the agreement.
After signing, go tocompletion_urltext
An https page to send signers to when done.

Outputs

idtext
nametext
statetext
Example output
{
  "id": "CBJCHBCAABAA-widget",
  "name": "Volunteer waiver",
  "state": "ACTIVE"
}

Get Acrobat Sign agreement

Get an agreement's status, recipients and settings.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.

Outputs

cc_emailslist
created_datetext
expiration_timetext
external_idtext
group_idtext
has_form_field_datatrue/false
idtext
last_event_datetext
localetext
messagetext
nametext
parent_idtext
participant_setslist
reminder_frequencytext
sender_emailtext
signature_typetext
statustext
typetext
workflow_idtext
Example output
{
  "cc_emails": [],
  "created_date": "2026-10-12T09:30:00Z",
  "expiration_time": null,
  "external_id": null,
  "group_id": "CBJCHBCAABAA-group",
  "has_form_field_data": false,
  "id": "CBJCHBCAABAA-agreement",
  "last_event_date": "2026-10-12T09:31:00Z",
  "locale": "en_US",
  "message": "Please sign.",
  "name": "Service agreement",
  "parent_id": null,
  "participant_sets": [
    {
      "id": "CBJCHBCAABAA-set",
      "members": [
        {
          "email": "client@example.com",
          "id": "CBJCHBCAABAA-participant",
          "name": null,
          "status": "ACTIVE"
        }
      ],
      "name": null,
      "order": 1,
      "role": "SIGNER"
    }
  ],
  "reminder_frequency": null,
  "sender_email": "owner@example.com",
  "signature_type": "ESIGN",
  "status": "OUT_FOR_SIGNATURE",
  "type": "AGREEMENT",
  "workflow_id": null
}

A short-lived link to download the agreement as one PDF - the signed copy once it is complete.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.
Include audit reportattach_audit_reporttrue/false
Append the audit report to the PDF.Default: false.
Include supporting documentsattach_supporting_documentstrue/false
Append files recipients attached.Default: true.

Outputs

locked_for_editingtrue/false
urltext
Example output
{
  "locked_for_editing": false,
  "url": "https://secure.na1.adobesign.com/document/cp/x/agreement.pdf"
}

Get Acrobat Sign form data

The values recipients entered into the agreement's fields, one row per participant. Only the agreement's sender can read them.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.
Include unfinished agreementsinclude_in_progresstrue/false
Also read agreements that are still out for signature. Otherwise only completed ones return data.Default: false.

Outputs

columnslist
countnumber
csvtext
rowslist
Example output
{
  "columns": [
    "email",
    "Company"
  ],
  "count": 1,
  "csv": "\"email\",\"Company\"\n\"client@example.com\",\"Acme\"\n",
  "rows": [
    {
      "Company": "Acme",
      "email": "client@example.com"
    }
  ]
}

Get the links the current signers use to sign, e.g. to send them yourself or embed them.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.

Outputs

countnumber
first_urltext
signing_urlslist
Example output
{
  "count": 1,
  "first_url": "https://secure.na1.adobesign.com/public/apiesign?pid=x",
  "signing_urls": [
    {
      "email": "client@example.com",
      "set_name": null,
      "url": "https://secure.na1.adobesign.com/public/apiesign?pid=x"
    }
  ]
}

Get current Acrobat Sign user

The Acrobat Sign user this connection signs in as.

Inputs

None.

Outputs

account_idtext
account_typetext
companytext
created_datetext
emailtext
first_nametext
full_nametext
idtext
is_account_admintrue/false
last_nametext
localetext
primary_group_idtext
statustext
titletext
Example output
{
  "account_id": "CBJCHBCAABAA-account",
  "account_type": "FREE",
  "company": "Acme",
  "created_date": "2026-01-05T10:00:00Z",
  "email": "owner@example.com",
  "first_name": "Ada",
  "full_name": "Ada Lovelace",
  "id": "CBJCHBCAABAA-user",
  "is_account_admin": true,
  "last_name": "Lovelace",
  "locale": "en_US",
  "primary_group_id": "CBJCHBCAABAA-group",
  "status": "ACTIVE",
  "title": null
}

List Acrobat Sign agreement documents

List the documents in an agreement, and any supporting files recipients attached.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.
Supporting files assupporting_document_formattext
Converted to PDF, or in their original format.One of: CONVERTED_PDF (Converted to PDF), ORIGINAL (Original format). Default: CONVERTED_PDF.

Outputs

countnumber
documentslist
supporting_documentslist
Example output
{
  "count": 1,
  "documents": [
    {
      "created_date": "2026-10-12T09:30:00Z",
      "id": "CBJCHBCAABAA-document",
      "label": null,
      "mime_type": "application/pdf",
      "name": "contract.pdf",
      "num_pages": 2
    }
  ],
  "supporting_documents": []
}

List Acrobat Sign agreement events

The agreement's audit trail: sent, viewed, signed, reminded and so on.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.

Outputs

countnumber
eventslist
latest_typetext
Example output
{
  "count": 1,
  "events": [
    {
      "acting_user_email": "owner@example.com",
      "acting_user_name": "Ada Lovelace",
      "comment": null,
      "date": "2026-10-12T09:30:00Z",
      "description": "Document created by owner@example.com",
      "id": "CBJCHBCAABAA-event",
      "participant_email": "owner@example.com",
      "participant_role": "SENDER",
      "type": "CREATED"
    }
  ],
  "latest_type": "CREATED"
}

List Acrobat Sign agreement members

List an agreement's recipients, cc's and sender, with the participant ids Send reminder needs.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.

Outputs

agreement_idtext
cclist
participant_idslist
participant_setslist
senderobject
Example output
{
  "agreement_id": "CBJCHBCAABAA-agreement",
  "cc": [],
  "participant_ids": [
    "CBJCHBCAABAA-participant"
  ],
  "participant_sets": [
    {
      "id": "CBJCHBCAABAA-set",
      "members": [
        {
          "company": null,
          "email": "client@example.com",
          "id": "CBJCHBCAABAA-participant",
          "is_self": false,
          "name": null,
          "status": "ACTIVE"
        }
      ],
      "name": null,
      "order": 1,
      "role": "SIGNER",
      "status": "WAITING_FOR_MY_SIGNATURE"
    }
  ],
  "sender": {
    "email": "owner@example.com",
    "name": "Ada Lovelace",
    "participant_id": "CBJCHBCAABAA-sender",
    "status": "COMPLETED"
  }
}

List Acrobat Sign agreements

List your agreements, most recent first.

Inputs

Page sizepage_sizenumber
How many to return (1-100).From 1 to 100. Default: 20.
Next page cursorcursortext
The next_cursor from a previous page, to read the next page.
Include hiddenshow_hiddentrue/false
Also include ones you have hidden in Acrobat Sign.Default: false.
External IDexternal_idtext
Only agreements with this external id.

Outputs

agreementslist
countnumber
next_cursortext
Example output
{
  "agreements": [
    {
      "display_date": "2026-10-12T09:30:00Z",
      "group_id": "CBJCHBCAABAA-group",
      "hidden": false,
      "id": "CBJCHBCAABAA-agreement",
      "name": "Service agreement",
      "parent_id": null,
      "participant_emails": [
        "client@example.com"
      ],
      "status": "OUT_FOR_SIGNATURE",
      "type": "AGREEMENT"
    }
  ],
  "count": 1,
  "next_cursor": null
}

List Acrobat Sign library templates

List the reusable templates in your library.

Inputs

Page sizepage_sizenumber
How many to return (1-100).From 1 to 100. Default: 20.
Next page cursorcursortext
The next_cursor from a previous page, to read the next page.
Include hiddenshow_hiddentrue/false
Also include ones you have hidden in Acrobat Sign.Default: false.

Outputs

countnumber
library_documentslist
next_cursortext
Example output
{
  "count": 1,
  "library_documents": [
    {
      "hidden": false,
      "id": "CBJCHBCAABAA-library",
      "modified_date": "2026-10-12T09:30:00Z",
      "name": "NDA",
      "owner_email": "owner@example.com",
      "sharing_mode": "USER",
      "status": "ACTIVE",
      "template_types": [
        "DOCUMENT"
      ]
    }
  ],
  "next_cursor": null
}

List Acrobat Sign users

List the users in your Acrobat Sign account.

Inputs

Which usersadmin_filtertext
Everyone, or only admins or non-admins.One of: ALL (Everyone), ADMIN_ONLY (Account admins only), NON_ADMIN_ONLY (Non-admins only). Default: ALL.
Page sizepage_sizenumber
How many to return (1-100).From 1 to 100. Default: 20.
Next page cursorcursortext
The next_cursor from a previous page, to read the next page.

Outputs

countnumber
next_cursortext
userslist
Example output
{
  "count": 1,
  "next_cursor": null,
  "users": [
    {
      "account_id": "CBJCHBCAABAA-account",
      "company": "Acme",
      "email": "owner@example.com",
      "first_name": "Ada",
      "id": "CBJCHBCAABAA-user",
      "is_account_admin": true,
      "last_name": "Lovelace"
    }
  ]
}

List Acrobat Sign web forms

List your web forms with their public links.

Inputs

Page sizepage_sizenumber
How many to return (1-100).From 1 to 100. Default: 20.
Next page cursorcursortext
The next_cursor from a previous page, to read the next page.
Include hiddenshow_hiddentrue/false
Also include ones you have hidden in Acrobat Sign.Default: false.

Outputs

countnumber
next_cursortext
web_formslist
Example output
{
  "count": 1,
  "next_cursor": null,
  "web_forms": [
    {
      "embed_code": "<script src='...'></script>",
      "group_id": "CBJCHBCAABAA-group",
      "hidden": false,
      "id": "CBJCHBCAABAA-widget",
      "modified_date": "2026-10-12T09:30:00Z",
      "name": "Volunteer waiver",
      "status": "ACTIVE",
      "url": "https://secure.na1.adobesign.com/public/esignWidget?wid=x"
    }
  ]
}

Search Acrobat Sign agreements

Find agreements by text, status, your role, participant or date. Drafts are not searchable, and a just-sent agreement can take a moment to appear.

Inputs

Search textquerytext
Words to look for in agreement names and fields.
Statusstatuseslist
Only agreements in these statuses.One or more of: OUT_FOR_SIGNATURE (Out for signature), OUT_FOR_APPROVAL (Out for approval), OUT_FOR_ACCEPTANCE (Out for acceptance), OUT_FOR_FORM_FILLING (Out for form filling), OUT_FOR_DELIVERY (Out for delivery), WAITING_FOR_MY_SIGNATURE (Waiting for my signature), WAITING_FOR_MY_APPROVAL (Waiting for my approval), WAITING_FOR_AUTHORING (Waiting for authoring), SIGNED, APPROVED, and 7 more.
My roleroleslist
Only agreements where you have these roles.One or more of: SENDER (I sent it), SIGNER (I sign it), APPROVER (I approve it), CC (I am copied), FORM_FILLER (I fill it in), ACCEPTOR (I accept it), SHARE (It is shared with me).
Participant emailparticipant_emailtext
Only agreements this person takes part in.
Created on or aftercreated_fromdate
Earliest creation date.
Created on or beforecreated_todate
Latest creation date.
Sort bysort_bytext
What to order the results by.One of: MODIFIED_DATE (Last modified), CREATED_DATE (Created), EXPIRATION_DATE (Expiration date), NAME, STATUS. Default: MODIFIED_DATE.
Ordersort_ordertext
Descending or ascending.One of: DESC (Newest / Z first), ASC (Oldest / A first). Default: DESC.
Page sizepage_sizenumber
How many to return (1-100).From 1 to 100. Default: 20.
Start atstart_indexnumber
The next_index from a previous search, for more.From 0 to 9999.

Outputs

agreementslist
countnumber
next_indexnumber
total_hitsnumber
Example output
{
  "agreements": [
    {
      "created_date": "2026-10-12T09:30:00Z",
      "expiration_date": null,
      "id": "CBJCHBCAABAA-agreement",
      "modified_date": "2026-10-12T09:31:00Z",
      "name": "Service agreement",
      "participant_emails": [
        "client@example.com"
      ],
      "roles": [
        "SENDER"
      ],
      "status": "OUT_FOR_SIGNATURE",
      "type": "AGREEMENT"
    }
  ],
  "count": 1,
  "next_index": null,
  "total_hits": 1
}

Send Acrobat Sign agreement

Send a document to one or more people to sign, approve or fill in. If the document has no signature field, Acrobat Sign adds a signature page.

Inputs

Agreement namenametextRequired
Shown to recipients as the email subject.
Recipientsrecipient_emailslistRequired
Email address of each recipient.
Uploaded document IDtransient_document_idtext
The transient_document_id from Upload document (valid for 7 days). Give this or a file URL.
Library templatelibrary_document_idtext
Send a saved library template instead.
File URLfile_urltext
A public https link to the file. Acrobat Sign downloads it itself, so it must not need a sign-in.
File namefile_nametext
Name for the file from the link, with its extension (e.g. contract.pdf). Taken from the link when left blank.
Recipients' roleroletext
What each recipient is asked to do.One of: SIGNER, APPROVER, ACCEPTOR, FORM_FILLER (Form filler), CERTIFIED_RECIPIENT (Certified recipient). Default: SIGNER.
Signing ordersigning_ordertext
With several recipients: in turn, or all at once.One of: SEQUENTIAL (One after another, in the order listed), PARALLEL (All at once). Default: SEQUENTIAL.
Messagemessagetext
A message to the recipients.
CCcc_emailslist
Email addresses to copy on the agreement.
Expiresexpirationdate and time
When the agreement expires if not completed.
Remindersreminder_frequencytext
Remind recipients automatically until they act.One of: DAILY_UNTIL_SIGNED (Every day until signed), WEEKDAILY_UNTIL_SIGNED (Every weekday until signed), EVERY_OTHER_DAY_UNTIL_SIGNED (Every other day until signed), EVERY_THIRD_DAY_UNTIL_SIGNED (Every third day until signed), EVERY_FIFTH_DAY_UNTIL_SIGNED (Every fifth day until signed), WEEKLY_UNTIL_SIGNED (Every week until signed), ONCE.
Signature typesignature_typetext
Electronic, or print-sign-and-upload.One of: ESIGN (Electronic signature), WRITTEN (Written (print, sign and upload)). Default: ESIGN.
Send now or save draftstatetext
Send it straight away, or save it as a draft.One of: IN_PROCESS (Send it now), DRAFT (Save as a draft). Default: IN_PROCESS.
External IDexternal_idtext
Your own reference, e.g. an order number.

Outputs

idtext
nametext
recipient_emailslist
statetext
Example output
{
  "id": "CBJCHBCAABAA-agreement",
  "name": "Service agreement",
  "recipient_emails": [
    "client@example.com"
  ],
  "state": "IN_PROCESS"
}

Send Acrobat Sign reminder

Remind recipients who have not acted yet.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.
Recipients to remindparticipant_idslistRequired
Who to remind (participant ids from List agreement members). cc'd people cannot be reminded.
Notenotetext
A note included in the reminder email.
Repeatfrequencytext
Send once, or keep reminding until they act.One of: DAILY_UNTIL_SIGNED (Every day until signed), WEEKDAILY_UNTIL_SIGNED (Every weekday until signed), EVERY_OTHER_DAY_UNTIL_SIGNED (Every other day until signed), EVERY_THIRD_DAY_UNTIL_SIGNED (Every third day until signed), EVERY_FIFTH_DAY_UNTIL_SIGNED (Every fifth day until signed), WEEKLY_UNTIL_SIGNED (Every week until signed), ONCE. Default: ONCE.
First reminder after (hours)first_reminder_delay_hoursnumber
Wait this many hours before the first reminder.From 1 to 8760.

Outputs

agreement_idtext
disabled_recipientslist
idtext
participant_idslist
Example output
{
  "agreement_id": "CBJCHBCAABAA-agreement",
  "disabled_recipients": [],
  "id": "CBJCHBCAABAA-reminder",
  "participant_ids": [
    "CBJCHBCAABAA-participant"
  ]
}

Set Acrobat Sign agreement note

Set your private note on an agreement. Only you see it, and it replaces any note you set before.

Inputs

Agreement IDagreement_idtextRequired
The agreement's id, from Send agreement, List agreements or Search agreements. A link to the agreement that contains its id also works.
NotenotetextRequired
The note text.

Outputs

idtext
notetext
Example output
{
  "id": "CBJCHBCAABAA-agreement",
  "note": "Chase Friday."
}

Upload document to Acrobat Sign

Upload a file, or plain text as a .txt document, for use in Send agreement, Create library template or Create web form. The returned id works for 7 days.

Inputs

Filefiletext
The file to upload. Give this or text content.
Text contenttext_contenttext
Plain text to upload as a .txt document, instead of a file.
File namefile_nametext
Name to give the document, with its extension. Defaults to the uploaded file's name, or document.txt.

Outputs

file_nametext
size_bytesnumber
transient_document_idtext
Example output
{
  "file_name": "contract.pdf",
  "size_bytes": 48213,
  "transient_document_id": "CBSCTBABDUAAABACAABAA-transient"
}

On this page