Compartilhar via

GetAccept

  • Reference

GetAccept provides a sales enablement platform for sales to design, send, promote, track, and e-sign sales documents, leveraging sales collateral, contract management, proposals, and electronic signatures in one place.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name GetAccept API Team
URL https://app.getaccept.com/api
Email integrations@getaccept.com
Connector Metadata
Publisher GetAccept, Inc.
Website https://www.getaccept.com
Privacy policy https://www.getaccept.com/privacy-policy
Categories Sales and CRM;Productivity

GetAccept provides a sales enablement platform for sales to design, send, promote, track, and e-sign sales documents, leveraging sales collateral, contract management, proposals, and electronic signatures in one place. This connector helps to automate your workflows for document storage, retrieval, task assignment, and customized notifications.

Prerequisites

A GetAccept account is required to use this connection. Go to getaccept.com to register a free account.

How to get credentials?

Only a valid GetAccept account is required as OAuth2 is used to authenticate the current logged-in user in GetAccept.

Known issues and limitations

Please contact our [mailto:support@getaccept.com](technical support) for any integration related issues.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create and send document or template

You must create a document to be able to send it to a recipient. When creating a document you can refer to previously uploaded files with file_id or you can choose to create a document and upload the files in on API post. You can only upload ONE file when including a file in the create document POST.

Use either file_ids parameter to use existing uploaded file(s), file_content to send the document as base64 encoded string or do a multipart post with file parameter.

All recipients must have either a valid e-mail or a mobile number.

All events are recorded using requestor IP address. You can override this using header CLIENT_IP containing the end-users public IP address.
Create contact

This will create a new contact in the database for the current entity
Create user

This will create a new contact in the database for the current entity
Download document

Document file can always be downloaded but most likely you want to download it when it has status Signed.

You can select to receive a download-url or get the binary file.

The download URL is accessable 10 minutes after a request has been made.
Get document attachments

Get document attachments by specifying a document id.
Get document details

Get document details by specifying a document id.
Get document fields

Get a list of fields for a document or template. Can be used both before and after a document has been signed.
Get document recipients

Get a list of recipients for a specific document.
Get template fields

Receive a list of fields for a specific template.
Get template pricing tables

Receive a list of pricing-table items for a specific template.
Get template roles

Receive a list of roles for a specific template.
Get user details

This call will return details of a single user. Receive details and available entities of the current authenticated user using user-id me
List attachments

Receive a list of available attachments. You can add new attachments in GetAccept using a new document.
List contacts

Receive a list of available contact for the current entity. All contacts added as a recipient are saved as a contact and is available for later use on that entity.
List documents

Get a list of available documents
List templates

Receive a list of available document templates. You can add new templates under the Templates-section in GetAccept.
List users

Fetch a list of active users for the current authenticated entity
List videos

Receive a list of available videos on the entity. You can add new videos in the mobile app or inside GetAccept.
Send existing document

When you send a document via GetAccept, we deliver an email to all recipients, each containing a unique, secured link. This API call triggers the document send action and can only be performed on documents with document_status = draft. The document will be sent to recipients you provided when it was created.

If document was created using self-sign option it will also be self-signed by the authenticated or specified user before sending.
Update document expiration

Use this method to update the expiration date and time for a document.
Upload a document file

You can upload one file at a time and get a file id. The file id is used to connect a file with a GetAccept document which is sent to recipients. If you want to upload mutliple files you run multiple POST. We only accept files up to 10 MB as default. Uploaded file need to be imported/added to a document within 48 hours after uploading.

We recommended you to upload PDF files in order to guarantee the same look when sent. Other file types can be converted, such as:

Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Upload a video

You can upload attachment files to include with documents you send. Successful request will return the attachment_id. Use attachment_id to assign an attachment to a document.
Upload an attachment

You can upload attachment files to include with documents you send. Successful request will return the attachment_id. Use attachment_id to assign an attachment to a document.

Create and send document or template

Operation ID:
CreateDocument

You must create a document to be able to send it to a recipient. When creating a document you can refer to previously uploaded files with file_id or you can choose to create a document and upload the files in on API post. You can only upload ONE file when including a file in the create document POST.

Use either file_ids parameter to use existing uploaded file(s), file_content to send the document as base64 encoded string or do a multipart post with file parameter.

All recipients must have either a valid e-mail or a mobile number.

All events are recorded using requestor IP address. You can override this using header CLIENT_IP containing the end-users public IP address.

Parameters

Name Key Required Type Description
ID
 id string

Attachment ID received from list or after upload
Require view
 require_view boolean

Require that recipient view the attachment
Type
 type string

file or external where file is an uploaded file and external is a link to an external file
Field ID
 id string

ID of custom template field
Field Name
 name string

Name of custom template field
Field Value
 value string

Value of custom template field
Currency
 currency string

Currency, ex. SEK
Locale
 locale string

Locale, ex. sv-SE
Display Name
 display_name string

Display name of the pricing table
External ID
 external_id string

External ID to represent the summary object within a third-party system
Table ID
 id string

Table ID
Precalculated totals
 pre_calculated boolean

If pricing table totals should be pre-calculated
Display Name
 display_name string

Display name of the pricing table
ID
 id string

Section ID
Rows
 rows

Array with values object with array of column_id, value
Enabled
 enabled boolean

If section discount should be enabled
Flat fee
 flat_fee boolean

If section should use using flat fee discounts
Discount Value
 value string

The value for section discount
Enabled
 enabled boolean

If section price should be enabled
Flat fee
 flat_fee boolean

If section should use using flat fee pricing
Price Value
 value string

The value for section price
Enabled
 enabled boolean

If section tax should be enabled
Flat fee
 flat_fee boolean

If section should use using flat fee taxes
Tax Value
 value string

The value for section tax
Enabled
 enabled boolean

If pricing table discount should be enabled
Flat fee
 flat_fee boolean

If pricing table should use using flat fee discounts
Discount Value
 value string

The value for summary discount
Enabled
 enabled boolean

If pricing table price should be enabled
Flat fee
 flat_fee boolean

If pricing table should use using flat fee pricing
Price Value
 value string

The value for summary price
Enabled
 enabled boolean

If pricing table tax should be enabled
Flat fee
 flat_fee boolean

If pricing table should use using flat fee taxes
Value
 value string

The value for summary tax
Expiration date
 expiration_date date-time

Date and time when the document should expire
External ID
 external_id string

External system ID for identification
File content
 file_content string

Base64 encoded file content
File IDs
 file_ids string

Comma-separated, unique file-ids received when uploading files
File name
 file_name string

Filename of the document, with the extension. This will be helpful for converting different file-types.
File URL
 file_url string

Url to document file. Documents must be public available for download
Send automatically
 is_automatic_sending boolean

If the document should be sent after creation
Send reminders
 is_reminder_sending boolean

Should automatic reminders be sent
Schedule sending
 is_scheduled_sending boolean

Should the sending be scheduled for sending in the future
Sign document
 is_signing boolean

Should the document be sent for signing
Handwritten signature
 is_signing_biometric boolean

Use handwritten signature
Allow signature transfer
 is_signing_forward boolean

Should recipients be able to transfer signature rights
Sign with initials
 is_signing_initials boolean

Sign document using recipient initials
Send SMS
 is_sms_sending boolean

Should the document be sent to recipient mobile by text
Document name
 name True string

Enter a name of the document
Company name
 company_name string

Company name of the recipient
Company number
 company_number string

Company number of the recipient
Email
 email string

Email address of the recipient
First name
 first_name string

Recipient first name
Last name
 last_name string

Last name of recipient
Mobile
 mobile string

Mobile phone in international format
Note
 note string

Additional note for a recipient
Signing order
 order_num integer

If signing order is enabled
Recipient type
 role string

The kind of recipient in the document
Template role
 role_name string

The name of the role in a template
Verify EID
 verify_eid boolean

Verify using EID
EID type
 verify_eid_type string

EID type to be used for personal verification
Enable question
 verify_qna boolean

Should a question be asked
Verification answer
 verify_qna_answer string

The answer to question
Question on open
 verify_qna_open boolean

Should question be asked before opening document
Verification question
 verify_qna_question string

Question to ask for verification
Sign question
 verify_qna_sign boolean

Should a question be asked before signing
Verify SMS
 verify_sms boolean

Verify recipient by SMS
Verify SMS on open
 verify_sms_open boolean

Verify SMS on open
Verify by SMS
 verify_sms_sign boolean

Should a SMS verify the recipient before signing
Schedule send date
 scheduled_sending_time date-time

Date and time when the document should be sent out
Sender email override
 sender_email string

Send from other email than authenticated user
Sender user override
 sender_id string

Send from other user than authenticated
Template ID
 template_id string

Select a template to use for the sending
Document type
 type string

Set the type/category of the document
Document value
 value integer

Value of deal or document
Video ID
 video_id string

Select a video to use for the sending

Returns

A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.

Document
Document

Create contact

Operation ID:
CreateContact

This will create a new contact in the database for the current entity

Parameters

Name Key Required Type Description
Company Name
 company_name string

Associated company name
Company Number
 company_number string

Associated company number
Email
 email string

Email address of the contact
First name
 first_name string

First name of the contact
Full name
 fullname string

Use to specify full name instead of first/last name
Last name
 last_name string

Last name of the contact
Mobile
 mobile string

Mobile number in international format
Note
 note string

Optional internal note for contact
Phone
 phone string

Phone number in international format
Title
 title string

The title of the contact, ex. CEO, Sales manager

Returns

Name Path Type Description
Contact ID
 contact_id string

ID of the created contact

Create user

Operation ID:
CreateUser

This will create a new contact in the database for the current entity

Parameters

Name Key Required Type Description
company_name
 company_name string

Associated company name
company_number
 company_number string

Associated company number
email
 email string

Email address of the contact
first_name
 first_name string

First name of the contact
fullname
 fullname string

Use to specify full name instead of first/last name
last_name
 last_name string

Last name of the contact
mobile
 mobile string

Mobile number in international format
note
 note string

Optional internal note for contact
phone
 phone string

Phone number in international format
title
 title string

The title of the contact, ex. CEO, Sales manager

Returns

A user is defined by it´s e-mail address and is connected to one or many entities.

User Roles

Administrator:

  • View all documents
  • Edit all documents
  • Change entity settings, info and billing
  • Add new users to the entity
  • Assign entity roles

Manager:

  • View team documents
  • Edit all documents
  • Add new users to the entity

Entity

An entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.

User
User

Download document

Operation ID:
DownloadDocument

Document file can always be downloaded but most likely you want to download it when it has status Signed.

You can select to receive a download-url or get the binary file.

The download URL is accessable 10 minutes after a request has been made.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID
Return the binary file directly
 direct string

Return the binary file directly

Returns

Name Path Type Description
document_url
 document_url string
file
 file string

Get document attachments

Operation ID:
GetDocumentAttachments

Get document attachments by specifying a document id.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID

Returns

Attachment list

Attachments
Attachments

Get document details

Operation ID:
GetDocumentDetails

Get document details by specifying a document id.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID

Returns

A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.

Document
Document

Get document fields

Operation ID:
ListDocumentFields

Get a list of fields for a document or template. Can be used both before and after a document has been signed.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID

Returns

Field list

Fields
Fields

Get document recipients

Operation ID:
ListRecipients

Get a list of recipients for a specific document.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID

Returns

Recipient list

Recipients
Recipients

Get template fields

Operation ID:
ListFields

Receive a list of fields for a specific template.

Parameters

Name Key Required Type Description
Template ID
 templateId True string

Template ID

Returns

Field list

Fields
Fields

Get template pricing tables

Operation ID:
GetPricingTables

Receive a list of pricing-table items for a specific template.

Parameters

Name Key Required Type Description
Template ID
 templateId True string

Template ID

Returns

Pricing Tables

Pricing
PricingTables

Get template roles

Operation ID:
ListRoles

Receive a list of roles for a specific template.

Parameters

Name Key Required Type Description
Template ID
 templateId True string

Template ID

Returns

Name Path Type Description
roles
 roles array of object
email
 roles.email string
first_name
 roles.first_name string
last_name
 roles.last_name string
mobile
 roles.mobile string
role
 roles.role string
role_id
 roles.role_id string
role_name
 roles.role_name string

Get user details

Operation ID:
GetUserDetails

This call will return details of a single user. Receive details and available entities of the current authenticated user using user-id me

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID

Returns

A user is defined by it´s e-mail address and is connected to one or many entities.

User Roles

Administrator:

  • View all documents
  • Edit all documents
  • Change entity settings, info and billing
  • Add new users to the entity
  • Assign entity roles

Manager:

  • View team documents
  • Edit all documents
  • Add new users to the entity

Entity

An entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.

User
User

List attachments

Operation ID:
ListAttachments

Receive a list of available attachments. You can add new attachments in GetAccept using a new document.

Returns

Attachment list

Attachments
Attachments

List contacts

Operation ID:
ListContacts

Receive a list of available contact for the current entity. All contacts added as a recipient are saved as a contact and is available for later use on that entity.

Returns

Contact list

Contacts
Contacts

List documents

Operation ID:
ListDocuments

Get a list of available documents

Parameters

Name Key Required Type Description
Filter list on status
 filter string

Filter list on status
How to sort results
 sort_by string

How to sort results
Sort order of results
 sort_order string

Sort order of results
Include documents from team members
 showteam boolean

Include documents from team members
Include all documents from entity
 showall boolean

Include all documents from entity
External ID
 external_id string

An external ID is a custom field which can contain a unique record identifier from a system outside of GetAccept
Offset
 offset number

Start list from record x until limit
Limit
 limit number

Number of records to list

Returns

Document list

Items
Documents

List templates

Operation ID:
ListTemplates

Receive a list of available document templates. You can add new templates under the Templates-section in GetAccept.

Parameters

Name Key Required Type Description
Show all
 showall string

Show all templates for entity
Folder ID
 folder_id string

Show templates in a specific folder

Returns

Name Path Type Description
templates
 templates array of object
tags
 templates.tags string
created_at
 templates.created_at string
external_editor_type
 templates.external_editor_type string
field_count
 templates.field_count integer
id
 templates.id string
is_editable
 templates.is_editable boolean
is_private
 templates.is_private boolean
name
 templates.name string
page_count
 templates.page_count integer
role_count
 templates.role_count integer
sender_name
 templates.sender_name string
sender_thumb_url
 templates.sender_thumb_url string
thumb_url
 templates.thumb_url string
type
 templates.type string
user_id
 templates.user_id string
video_id
 templates.video_id string
video_thumb_url
 templates.video_thumb_url string

List users

Operation ID:
ListUsers

Fetch a list of active users for the current authenticated entity

Returns

User list

Users
Users

List videos

Operation ID:
ListVideos

Receive a list of available videos on the entity. You can add new videos in the mobile app or inside GetAccept.

Returns

Name Path Type Description
videos
 videos array of object
editable
 videos.editable boolean
published
 videos.published boolean
saved
 videos.saved boolean
thumb_url
 videos.thumb_url string
video_id
 videos.video_id string
video_title
 videos.video_title string
video_type
 videos.video_type string
video_url
 videos.video_url string

Send existing document

Operation ID:
SendDocument

When you send a document via GetAccept, we deliver an email to all recipients, each containing a unique, secured link. This API call triggers the document send action and can only be performed on documents with document_status = draft. The document will be sent to recipients you provided when it was created.

If document was created using self-sign option it will also be self-signed by the authenticated or specified user before sending.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID
sender_email
 sender_email email

Use this to specify the sender user/owner by email address to be used for self-signing the document.
sender_id
 sender_id string

Use this to specify the sender user/owner by id to be used for self-signing the document.

Returns

A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.

Document
Document

Update document expiration

Operation ID:
UpdateExpiration

Use this method to update the expiration date and time for a document.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Document ID
Expiration date
 expiration_date date-time

Date and time when the document should expire (UTC)
Send notification
 send_notification boolean

Should a notification about the update be sent to recipients

Returns

Name Path Type Description
Status
 status integer

Status of update

Upload a document file

Operation ID:
UploadDocument

You can upload one file at a time and get a file id. The file id is used to connect a file with a GetAccept document which is sent to recipients. If you want to upload mutliple files you run multiple POST. We only accept files up to 10 MB as default. Uploaded file need to be imported/added to a document within 48 hours after uploading.

We recommended you to upload PDF files in order to guarantee the same look when sent. Other file types can be converted, such as:

Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv

Parameters

Name Key Required Type Description
File content
 file_content string

Send the file as base64 encoded. Note that base64 encoding files will increase the file size with about 30%
File name
 file_name string

Filename of the document, with the extension. This will be helpful for converting different file-types.
File URL
 file_url string

Url to document file. File must be available for download without any authorization

Returns

Name Path Type Description
file_id
 file_id string

ID of the uploaded file to be used in file_ids when creating a document
file_status
 file_status string

Status of the uploaded file

Upload a video

Operation ID:
UploadVideo

You can upload attachment files to include with documents you send. Successful request will return the attachment_id. Use attachment_id to assign an attachment to a document.

Parameters

Name Key Required Type Description
File content
 file_content string

Send the file as base64 encoded. Note that base64 encoding files will increase the file size with about 30%
File name
 file_name string

Filename of the document, with the extension. This will be helpful for converting different file-types.
File URL
 file_url string

Url to document file. File must be available for download without any authorization

Returns

Name Path Type Description
File status
 file_status string

Status of the video
File name
 filename string

File name of the video
Job ID
 job_id string

Id of the processing job converting and compressing the video. Poll for job status updates using /video/job/.
Video ID
 video_id string

ID of the uploaded video to be used in video_id when creating a document

Upload an attachment

Operation ID:
UploadAttachment

You can upload attachment files to include with documents you send. Successful request will return the attachment_id. Use attachment_id to assign an attachment to a document.

Parameters

Name Key Required Type Description
File content
 file_content string

Send the file as base64 encoded. Note that base64 encoding files will increase the file size with about 30%
File name
 file_name string

Filename of the document, with the extension. This will be helpful for converting different file-types.
File URL
 file_url string

Url to document file. File must be available for download without any authorization

Returns

Name Path Type Description
File name
 filename string

File name of the attachment
Attachment ID
 id string

ID of the uploaded attachment to be used in attachment_id when creating a document
Attachment title
 title string

Title of the attachment
Attachment type
 type string

Type of the attachment

Triggers

Subscribe to document events

This call will create a new subscription. The response will be wrapped in an array even for single object according to REST hook standards.

Events

  • document.created - Document is created
  • document.sent - Document is sent
  • document.viewed - Document is sent
  • document.signed - Document is signed
  • document.approved - Document is approved
  • document.expired - Document has expired
  • document.rejected - Document is rejected
  • document.downloaded - Document is downloaded
  • document.printed - Document is printed
  • document.forwarded - Document is forwarded
  • document.partially_signed - Document has been partially signed
  • document.commented - Document is commented
  • document.hardbounced - Document is hardbounced
  • document.imported - Document is imported
When a document has been rejected

Triggers when a document has been rejected by any of the recipients
When a document has been reviewed

Triggers when a document has been reviewed by any of the recipients
When a document has been signed

Triggers when a document has been signed by all signing parties

Subscribe to document events

Operation ID:
CreateSubscription

This call will create a new subscription. The response will be wrapped in an array even for single object according to REST hook standards.

Events

  • document.created - Document is created
  • document.sent - Document is sent
  • document.viewed - Document is sent
  • document.signed - Document is signed
  • document.approved - Document is approved
  • document.expired - Document has expired
  • document.rejected - Document is rejected
  • document.downloaded - Document is downloaded
  • document.printed - Document is printed
  • document.forwarded - Document is forwarded
  • document.partially_signed - Document has been partially signed
  • document.commented - Document is commented
  • document.hardbounced - Document is hardbounced
  • document.imported - Document is imported

Parameters

Name Key Required Type Description
Select event
 event True string

Event trigger
All entity users
 global boolean

If the webhook should catch events for all entity users.
Error email
 notification_email string

If the event fails, send a notification to this email instead of the sender
Payload
 payload string

Additional payload data to post

Returns

Webhook payload

Webhook
Webhook

When a document has been rejected

Operation ID:
CreateRejectedSubscription

Triggers when a document has been rejected by any of the recipients

Parameters

Name Key Required Type Description
All entity users
 global boolean

If the webhook should catch events for all entity users.
Error email
 notification_email string

If the event fails, send a notification to this email instead of the sender
Payload
 payload string

Additional payload data to post

Returns

Webhook payload

Webhook
Webhook

When a document has been reviewed

Operation ID:
CreateReviewedSubscription

Triggers when a document has been reviewed by any of the recipients

Parameters

Name Key Required Type Description
All entity users
 global boolean

If the webhook should catch events for all entity users.
Error email
 notification_email string

If the event fails, send a notification to this email instead of the sender
Payload
 payload string

Additional payload data to post

Returns

Webhook payload

Webhook
Webhook

When a document has been signed

Operation ID:
CreateSignedSubscription

Triggers when a document has been signed by all signing parties

Parameters

Name Key Required Type Description
All entity users
 global boolean

If the webhook should catch events for all entity users.
Error email
 notification_email string

If the event fails, send a notification to this email instead of the sender
Payload
 payload string

Additional payload data to post

Returns

Webhook payload

Webhook
Webhook

Definitions

Attachment

Document attachment

Name Path Type Description
Access Recipients
 access_recipient_names array of string

Recipients with access to the attachment
Description
 attachment_description string

Description of the attachment
Download URL
 attachment_download_url string

URL to download the attachment
File Extension
 attachment_extension string

File extension of the attachment
Filename
 attachment_filename string

Filename of the attachment
ID
 attachment_id string

ID of the attachment
Preview URL
 attachment_preview_url string

Internal URL to preview the attachment
Title
 attachment_title string

Title of the attachment
Type
 attachment_type string

Type of the attachment
URL
 attachment_url string

Url of the attachment
Last View
 last_attachment_view string

Date and time when the attachment was last viewed
Restricted access
 restrict_access boolean

Attachment has restricted access

Attachments

Attachment list

Name Path Type Description
attachments
 attachments array of Attachment

Contact

Every unique e-mail address (or mobile number) is defined as a contact.

Name Path Type Description
Company ID
 company_id string

Company ID
Company logo
 company_logo_url string

Company logo
Company name
 company_name string

Company name of the contact
Company number
 company_number string

Company number of the contact
Contact ID
 contact_id string

Contact ID
Created
 created_at string

Date of created contact
Documents
 document_count number

Number of documents for a contact
Contact email
 email string

Name of the created document
First name
 first_name string

First name of the contact
Full name
 fullname string

Full name of the contact
Gender
 gender string

Gender of the recipient
Last name
 last_name string

Last name of the contact
Mobile
 mobile string

Mobile number of the contact
Note
 note string

Note of the contact
Thumb URL
 thumb_url string

Thumb URL of the contact
Title
 title string

Title of the contact

Contacts

Contact list

Name Path Type Description
contacts
 contacts array of Contact

Document

A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.

Name Path Type Description
Tags
 tags string

Document tags
Automatic chat text
 auto_comment_text string

Automatic chat text
Company Name
 company_name string

Company Name
Created at
 created_at string

When document was created
Download URL
 download_url string

URL to download signed document
Email message
 email_send_message string

Sending email message
Email Subject
 email_send_subject string

Email subject text
Expiration date
 expiration_date string

Document expiration date
External Client ID
 external_client_id string
External Editor ID
 external_editor_id string

ID in external editor
External Editor Type
 external_editor_type string
External ID
 external_id string
Field count
 field_count integer

Number of fields in document
ID
 id string
Auto comment
 is_auto_comment boolean

If automatic chat comment is enabled
Auto Comment Email
 is_auto_comment_email boolean

If automatic chat email is enabled
Identify Recipient
 is_identify_recipient boolean

If document has identify recipient enabled
Is private
 is_private boolean

If the document is private
Send reminders
 is_reminder_sending boolean

If automatic reminders are enabled
Scheduled sending
 is_scheduled_sending boolean

If the document has scheduled sending
Self-signing
 is_selfsign boolean

If document has been self-signed by sender
Is signed
 is_signed boolean

If the document has been signed
Signable document
 is_signing boolean

If document is signable
Handwritten signature
 is_signing_biometric boolean

If handwritten signature is enabled
Allow signature transfer
 is_signing_forward boolean

If transfer of signing rights is enabled
Signature order
 is_signing_order boolean

If recipient signing order is enabled
Has Video
 is_video boolean

If the document has a introduction video
Name
 name string

Name of document
Parent ID
 parent_id string

ID of previous document version
Preview URL
 preview_url string

Link to internal preview of document
recipients
 recipients array of Recipient
Scheduled sending time
 scheduled_sending_time string

When the document was scheduled for sending
Send date
 send_date string

Document send date
Sender email
 sender_email string

Email address of sender user
Sender name
 sender_name string

Name of sender user
Sender thumb URL
 sender_thumb_url string

Thumb image of sender user
Sign date
 sign_date string

Document sign date
Status
 status string

Current status of document
Thumb URL
 thumb_url string

Thumb image of document
Type
 type string

Document type
Unique ID
 unique_id integer

Unique ID for document
User ID
 user_id string

ID of the sender user
Value
 value integer

Value of document

Documents

Document list

Name Path Type Description
tags
 tags string
company_name
 company_name string
created_at
 created_at string
expiration_date
 expiration_date string
id
 id string
is_private
 is_private boolean
is_signing
 is_signing boolean
name
 name string
sender_name
 sender_name string
sender_thumb
 sender_thumb string
status
 status string
type
 type string
value
 value integer

EditorField

Editor Field details

Name Path Type Description
ID
 id string

ID
Label
 input_settings.label string

Label
Options
 input_settings.options array of string

Options
Required
 input_settings.required boolean

Required
Type
 input_settings.type string

Type
Recipient ID
 recipient_id string

Recipient ID
Type
 type string

Type
User ID
 user_id string

User ID

Field

Field details

Name Path Type Description
Company Name
 company_name string

Company Name
Company Number
 company_number string

Company Number
Field ID
 field_id string

Field ID
Label
 field_label string

Label
Options
 field_options array of object

Options
Value
 field_options.value string
Type
 field_type string

Type
Value
 field_value string

Value
is_collectable
 is_collectable boolean

Collecting field
is_editable
 is_editable boolean

Editable field
is_required
 is_required boolean

Required field
Page ID
 page_id string

Page ID
Recipient ID
 recipient_id string

Recipient ID
Recipient Name
 recipient_name string

Recipient Name
Role Name
 role_name string

Role Name

Fields

Field list

Name Path Type Description
editor_fields
 editor_fields array of EditorField
fields
 fields array of Field

PricingColumn

Pricing Table Column

Name Path Type Description
ID
 column_id string

ID
Display Name
 display_name string

Display Name
Enabled
 enabled boolean

Enabled
Name
 name string

Name

PricingSection

Pricing Table Section

Name Path Type Description
columns
 columns array of PricingColumn
Display Name
 display_name string

Display Name
Name
 name string

Name
ID
 section_id string

ID

PricingTable

Pricing Table

Name Path Type Description
Currency
 currency_settings.currency string

Currency
Locale
 currency_settings.locale string

Locale
Pre calculated totals
 pre_calculated boolean

Pre calculated totals
sections
 sections array of PricingSection
ID
 table_id string

Table ID

PricingTables

Pricing Tables

Name Path Type Description
pricing_tables
 pricing_tables array of PricingTable

Recipient

Every unique e-mail address (or mobile number) that is connected to a document is a recipient.

Name Path Type Description
Company name
 company_name string

Company name of the recipient
Company number
 company_number string

Company number of the recipient
Document URL
 document_url string

Unique URL for the recipient to view/sign
Recipient email
 email string

Email of the recipient
First name
 first_name string

First name of the recipient
Full name
 fullname string

Full name of the recipient
Gender
 gender string

Gender of the recipient
ID
 id string

ID of the recipient
Last name
 last_name string

Last name of the recipient
Mobile
 mobile string

Mobile number of the recipient
Note
 note string

Note of the recipient
Signing order num
 order_num string

Signing order of the recipient
Status
 status string

Status of the recipient
Thumb URL
 thumb_url string

Thumb URL of the recipient
Title
 title string

Title of the recipient

Recipients

Recipient list

Name Path Type Description
recipients
 recipients array of Recipient

User

A user is defined by it´s e-mail address and is connected to one or many entities.

User Roles

Administrator:

  • View all documents
  • Edit all documents
  • Change entity settings, info and billing
  • Add new users to the entity
  • Assign entity roles

Manager:

  • View team documents
  • Edit all documents
  • Add new users to the entity

Entity

An entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.

Name Path Type Description
App Mode
 app_mode string
disallow_create
 disallow_create boolean
Email
 email string

Email address of the user
Entity ID
 entity_id string
Entity Name
 entity_name string
First name
 first_name string

First name of the user
ID
 id string

ID of the user
Language
 language string
Last name
 last_name string

Last name of the user
mobile
 mobile string

Mobile number in international format
Note
 note string

Optional internal note for user
Phone
 phone string

Phone number in international format
Role
 role string
Skip sending invitation
 skip_invitation boolean
Status
 status string
Team ID
 team_id string
Thumb URL
 thumb_url string
Timezone
 timezone string
Title
 title string

The title of the user, ex. CEO, Sales manager

Users

User list

Name Path Type Description
users
 users array of object
Email
 users.email string
First Name
 users.first_name string
Last Login
 users.last_login string
Last Name
 users.last_name string
User Name
 users.name string
Role
 users.role string
Status
 users.status string
Team Name
 users.team_name string
User ID
 users.user_id string

Webhook

Webhook payload

Name Path Type Description
Custom Fields
 custom_fields object
Document
 document Document

A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.
Entity custom domain
 entity.custom_domain string

Custom domain setting for entity
Default email message
 entity.email_send_message string

Default email message
Default email subject
 entity.email_send_subject string

Default email subject
Entity sub-domain
 entity.sub_domain string

Sub-domain for the entity
Event name
 event string
Event action
 event_action string
Event type
 event_type string
Recipient
 recipient Recipient

Every unique e-mail address (or mobile number) that is connected to a document is a recipient.
Subscription ID
 subscription_id string