← Tools Reference

SignWell

SignWell integration (Productivity, Communication). Imported from open-connector.

API key6 toolshttps://www.signwell.com
GET
signwell_get_me
Get the authenticated SignWell account, workspace, and user information.

/api/v1/me

GET
signwell_get_template
Retrieve one SignWell document template by ID.

/api/v1/document_templates/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe SignWell identifier.
POST
signwell_create_document_from_template
Create a SignWell document from one or more templates.

/api/v1/document_templates/documents

32 parameters
ParamTypeRequiredDescription
template_idstringoptionalThe SignWell identifier.
template_idsarrayoptionalTemplate IDs used to create the document.
draftbooleanoptionalWhether to leave the created document as a draft.
with_signature_pagebooleanoptionalWhether to append a signature page.
text_tagsbooleanoptionalWhether SignWell should parse text tags.
languagestringoptionalThe string value.
recipientsarrayoptionalRecipients assigned to the SignWell document.
exclude_placeholdersarrayoptionalTemplate placeholder names to exclude.
template_fieldsarrayoptionalTemplate field values passed through to SignWell.
filesarrayoptionalAdditional files to attach to the document.
fieldsarrayoptionalField definitions passed through to SignWell.
attachment_requestsarrayoptionalAttachment requests passed through to SignWell.
copied_contactsarrayoptionalCopied contacts passed through to SignWell.
test_modebooleanoptionalWhether SignWell should create the document in test mode.
namestringoptionalThe string value.
subjectstringoptionalThe string value.
messagestringoptionalThe string value.
expires_inintegeroptionalNumber of days until the document expires.
remindersbooleanoptionalWhether SignWell should send automatic reminders.
apply_signing_orderbooleanoptionalWhether recipients must sign in signing_order sequence.
api_application_idstringoptionalThe string value.
embedded_signingbooleanoptionalWhether to enable embedded signing.
embedded_signing_notificationsbooleanoptionalWhether embedded signing should send notifications.
custom_requester_namestringoptionalThe string value.
custom_requester_emailstringoptionalThe custom requester email address.
redirect_urlstringoptionalThe URL where SignWell redirects after signing.
allow_declinebooleanoptionalWhether recipients can decline signing.
allow_reassignbooleanoptionalWhether recipients can reassign signing.
decline_redirect_urlstringoptionalThe URL where SignWell redirects after a decline.
metadataobjectoptionalOptional SignWell metadata key-value pairs.
labelsarrayoptionalLabels to assign to the SignWell document.
checkbox_groupsarrayoptionalCheckbox groups to create on the document.
GET
signwell_get_document
Retrieve one SignWell document by ID.

/api/v1/documents/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe SignWell identifier.
POST
signwell_send_document
Send a SignWell draft document for signing.

/api/v1/documents/{id}/send

20 parameters
ParamTypeRequiredDescription
idstringrequiredThe SignWell identifier.
test_modebooleanoptionalWhether SignWell should create the document in test mode.
namestringoptionalThe string value.
subjectstringoptionalThe string value.
messagestringoptionalThe string value.
expires_inintegeroptionalNumber of days until the document expires.
remindersbooleanoptionalWhether SignWell should send automatic reminders.
apply_signing_orderbooleanoptionalWhether recipients must sign in signing_order sequence.
api_application_idstringoptionalThe string value.
embedded_signingbooleanoptionalWhether to enable embedded signing.
embedded_signing_notificationsbooleanoptionalWhether embedded signing should send notifications.
custom_requester_namestringoptionalThe string value.
custom_requester_emailstringoptionalThe custom requester email address.
redirect_urlstringoptionalThe URL where SignWell redirects after signing.
allow_declinebooleanoptionalWhether recipients can decline signing.
allow_reassignbooleanoptionalWhether recipients can reassign signing.
decline_redirect_urlstringoptionalThe URL where SignWell redirects after a decline.
metadataobjectoptionalOptional SignWell metadata key-value pairs.
labelsarrayoptionalLabels to assign to the SignWell document.
checkbox_groupsarrayoptionalCheckbox groups to create on the document.
POST
signwell_send_document_reminder
Send a reminder for a SignWell document.

/api/v1/documents/{id}/remind

2 parameters
ParamTypeRequiredDescription
idstringrequiredThe SignWell identifier.
recipientsarrayoptionalOptional recipient subset to remind.