Templates

Get template

Get template details by specifying a template id in the request URL. The response holds the same properties as Get a document, without the recipients list and without the pages, page_count, stats, attachments and rejection_reason that Get a document can include.

get/v1/templates/{templateId}

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/templates/{templateId}
  • Auth: HTTP bearer

Path parameters

templateIdstring required

Id of the template.

Response

The request succeeded.

idstring required

Unique identifier of the document.

namestring required

Name of the document as it is presented to the recipients.

valuenumber required

Monetary value of the document in the entity currency.

typestring required

Document type, which sets the defaults and the look of the document.

tagsstring required

Comma separated document tags.

thumb_urlstring required

URL of the thumbnail of the first document page.

external_idstring required

External identifier of the document, empty unless it was set by the caller.

external_client_idstring required

Client that created the document. Create document stores the client id of the access token: the client_id sent when authenticating, the OAuth client id, or api when neither is set. Empty when the document has no client stored.

external_editor_typestring required

External editor the document content is edited in.

external_editor_idstring required

Identifier of the document in its external editor.

company_namestring required

Company the document is sent to.

company_numberstring required

Registration number of the company the document is sent to.

company_idstring required

Identifier of the company the document is sent to.

company_logo_urlstring required

URL of the logo of the company the document is sent to.

unique_idnumber required

Number the document was given in the running order of the entity.

is_selfsignboolean required

Whether the sender also signs the document, inherited from the entity when unset on the document.

is_signing_biometricboolean required

Whether signers draw their signature on screen, inherited from the entity when unset on the document.

is_signing_initialsboolean required

Whether signers write their initials when signing, inherited from the entity when unset on the document.

is_signing_forwardboolean required

Whether a recipient may forward the signing rights, inherited from the entity when unset on the document.

is_identify_recipientboolean required

Whether returning recipients are identified by cookie, inherited from the entity when unset on the document.

is_privateboolean required

Whether the document can only be viewed by its owner.

status'draft' | 'archived' | 'expired' | 'hardbounced' | 'importing' | 'lost' | 'processing' | 'recalled' | 'rejected' | 'reviewed' | 'scheduled' | 'sealed' | 'sent' | 'signed' | 'signedwithoutverification' | 'viewed' required

Current status of the document.

send_datestring nullable required

When the document was sent, or null while it is a draft.

sign_datestring nullable required

When the last required signature was collected, or null while the document is unsigned.

created_atstring required

When the document was created.

updated_atstring nullable required

When the document was last updated, or null when that is unavailable.

download_urlstring required

URL the document file can be downloaded from.

app_urlstring required

URL of the document view page in the app.

user_idstring required

Id of the user that owns the document.

sender_namestring required

Full name of the user that owns the document.

sender_thumb_urlstring required

URL of the avatar of the user that owns the document.

sender_emailstring required

Email address of the user that owns the document.

parent_idstring required

Id of the document this document is a new version of. Empty when the document is not a new version.

email_send_template_idstring required

Id of the email template the document is sent with, 0 when none is set.

email_send_subjectstring required

Subject line the document is sent with.

email_send_messagestring required

Message to the recipients the document is sent with.

is_signingboolean required

Whether the document is signable.

is_signing_orderboolean required

Whether signers are notified one at a time in their given order instead of all at once.

is_signedboolean required

Whether the document has been signed.

expiration_datestring nullable required

When the document stops being available to the recipients, or null when it never expires.

is_scheduled_sendingboolean required

Whether the automatic sending is scheduled instead of immediate.

scheduled_sending_timestring nullable required

When the scheduled sending runs, or null when no sending is scheduled.

is_reminder_sendingboolean required

Whether reminders are sent automatically, inherited from the entity when unset on the document.

is_videoboolean required

Whether a video is presented before the document is opened.

video_idstring nullable required

Id of the video presented before the document is opened, or null when there is none.

is_auto_commentboolean required

Whether a comment is posted automatically, inherited from the entity when unset on the document.

auto_comment_textstring required

Text of the automatic comment on the document.

is_auto_comment_emailboolean required

Whether the automatic comment is also emailed, inherited from the entity when unset on the document.

auto_comment_emailstring required

Email address the automatic comment of the document is sent to.

entity_auto_comment_textstring required

Automatic comment text configured on the entity.

entity_auto_comment_emailstring required

Email address for automatic comments configured on the entity.

field_countnumber required

Number of fields on the document.

contract_start_datestring nullable required

Start date of the contract for contract management, or null when unset.

contract_end_datestring nullable required

End date of the contract for contract management, or null when unset.

preview_urlstring required

URL that opens the document in preview mode.

name_templatestring

Contract name template configured on this template, returned raw. May contain {{entity.company_name}}, {{document.company_name}}, {{document.id}}, {{document.unique_id}} and {{date}}; Create document resolves {{document.company_name}} from the top-level company_name, {{document.id}} to the newly created document ID and {{document.unique_id}} to its unique ID, or removes {{document.unique_id}} when the company has no unique ID counter. Only present on templates that have one configured.

Changes

No recorded changes to this operation across all 1 revision of this API.