OpenAPI Specification
openapi: 3.0.0
info:
contact:
email: integrations@getaccept.com
name: GetAccept API Team
url: https://app.getaccept.com/api
description: 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.
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: https://www.getaccept.com/terms.html
title: GetAccept Archive Documents API
version: '1.6'
servers:
- description: Production endpoint
url: https://api.getaccept.com/v1
security:
- Oauth2:
- basic
- Token: []
tags:
- externalDocs:
url: https://app.getaccept.com/api/#documents
description: Everything related to documents
name: Documents
paths:
/documents:
get:
parameters:
- description: Filter list on status
explode: false
in: query
name: filter
schema:
enum:
- draft
- sent
- viewed
- reviewed
- signed
- rejected
- recalled
example: signed
type: string
x-ms-summary: Filter list on status
- description: How to sort results
in: query
name: sort_by
schema:
enum:
- name
- value
- created
- recipient
- status
- owner
example: created
type: string
x-ms-summary: How to sort results
- description: Sort order of results
in: query
name: sort_order
schema:
enum:
- asc
- desc
example: desc
type: string
x-ms-summary: Sort order of results
- description: Include documents from team members
in: query
name: showteam
schema:
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Include documents from team members
- description: Include all documents from entity
in: query
name: showall
schema:
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Include all documents from entity
- description: An external ID is a custom field which can contain a unique record identifier from a system outside of GetAccept
in: query
name: external_id
schema:
type: string
x-ms-summary: External ID
- description: Start list from record x until limit
in: query
name: offset
schema:
example: 50
type: number
x-ms-summary: Offset
- description: Number of records to list
in: query
name: limit
schema:
example: 100
type: number
x-ms-summary: Limit
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Documents'
description: OK
'401':
$ref: '#/components/responses/Unauthorized'
tags:
- Documents
description: Get a list of available documents
operationId: ListDocuments
summary: List documents
post:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
description: OK
'400':
$ref: '#/components/responses/Invalid'
'401':
$ref: '#/components/responses/Unauthorized'
tags:
- Documents
description: '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.'
operationId: CreateDocument
requestBody:
content:
application/json:
schema:
properties:
attachments:
description: Attachments
items:
properties:
id:
description: Attachment ID received from list or after upload
type: string
x-ms-dynamic-values:
operationId: ListAttachments
value-collection: attachments
value-path: attachment_id
value-title: attachment_title
x-ms-summary: ID
require_view:
description: Require that recipient view the attachment
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Require view
type:
description: file or external where file is an uploaded file and external is a link to an external file
enum:
- file
- external
type: string
x-ms-summary: Type
type: object
type: array
x-ms-summary: Attachment
custom_data:
description: A list of custom data to include with the document. If the property is already defined on the template, it will be overridden by the value provided here.
properties:
properties:
description: An array of objects containing custom data properties
items:
properties:
key:
description: Key of the custom data property
type: string
x-ms-summary: Key
label:
description: Label of the custom data property
type: string
x-ms-summary: Label
value:
description: Value of the custom data property
type: string
x-ms-summary: Value
value_type:
description: 'Type of the value: string, number, boolean'
enum:
- string
- number
- boolean
type: string
x-ms-summary: Value Type
type: object
type: array
x-ms-summary: Properties
type: object
x-ms-summary: Custom Data
x-ms-visibility: advanced
custom_fields:
description: Custom field
items:
properties:
id:
description: ID of custom template field
type: string
x-ms-summary: Field ID
name:
description: Name of custom template field
type: string
x-ms-summary: Field Name
value:
description: Value of custom template field
type: string
x-ms-summary: Field Value
type: object
type: array
x-ms-summary: Custom
custom_pricing_tables:
description: Pricing
items:
properties:
currency_settings:
description: Currency Settings
properties:
currency:
description: Currency, ex. SEK
type: string
x-ms-summary: Currency
locale:
description: Locale, ex. sv-SE
type: string
x-ms-summary: Locale
type: object
x-ms-summary: Currency Settings
x-ms-visibility: advanced
display_name:
description: Display name of the pricing table
type: string
x-ms-summary: Display Name
x-ms-visibility: advanced
external_id:
description: External ID to represent the summary object within a third-party system
type: string
x-ms-summary: External ID
x-ms-visibility: advanced
id:
description: Table ID
type: string
x-ms-summary: Table ID
x-ms-visibility: advanced
pre_calculated:
default: false
description: If pricing table totals should be pre-calculated
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Precalculated totals
x-ms-visibility: advanced
sections:
description: Sections
items:
properties:
display_name:
description: Display name of the pricing table
type: string
x-ms-summary: Display Name
id:
description: Section ID
type: string
x-ms-summary: ID
rows:
additionalProperties:
items:
type: object
type: array
description: Array with values object with array of column_id, value
example:
- values:
- column_id: abc123
value: My product
- column_id: def456
value: 240
x-ms-summary: Rows
section_summary:
properties:
discount:
properties:
enabled:
description: If section discount should be enabled
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enabled
flat_fee:
description: If section should use using flat fee discounts
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Flat fee
value:
description: The value for section discount
type: string
x-ms-summary: Discount Value
type: object
x-ms-summary: Discount
price:
properties:
enabled:
description: If section price should be enabled
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enabled
flat_fee:
description: If section should use using flat fee pricing
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Flat fee
value:
description: The value for section price
type: string
x-ms-summary: Price Value
type: object
x-ms-summary: Price
tax:
properties:
enabled:
description: If section tax should be enabled
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enabled
flat_fee:
description: If section should use using flat fee taxes
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Flat fee
value:
description: The value for section tax
type: string
x-ms-summary: Tax Value
type: object
x-ms-summary: Tax
type: object
x-ms-summary: Summary Values
type: object
type: array
x-ms-summary: Section
x-ms-visibility: advanced
summary_values:
properties:
discount:
properties:
enabled:
description: If pricing table discount should be enabled
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enabled
x-ms-visibility: advanced
flat_fee:
description: If pricing table should use using flat fee discounts
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Flat fee
x-ms-visibility: advanced
value:
description: The value for summary discount
type: string
x-ms-summary: Discount Value
type: object
x-ms-summary: Discount
price:
properties:
enabled:
description: If pricing table price should be enabled
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enabled
x-ms-visibility: advanced
flat_fee:
description: If pricing table should use using flat fee pricing
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Flat fee
x-ms-visibility: advanced
value:
description: The value for summary price
type: string
x-ms-summary: Price Value
type: object
x-ms-summary: Price
tax:
properties:
enabled:
description: If pricing table tax should be enabled
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enabled
x-ms-visibility: advanced
flat_fee:
description: If pricing table should use using flat fee taxes
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Flat fee
x-ms-visibility: advanced
value:
description: The value for summary tax
type: string
x-ms-summary: Value
type: object
x-ms-summary: Tax
type: object
x-ms-summary: Summary Values
x-ms-visibility: advanced
type: object
type: array
x-ms-summary: Pricing
x-ms-visibility: advanced
email_send_message:
description: Use this to specify a message to the recipient(s) when sending out the document
type: string
x-ms-summary: Email message
x-ms-visibility: advanced
expiration_date:
description: Date and time when the document should expire
format: date-time
type: string
x-ms-summary: Expiration date
x-ms-visibility: advanced
external_eid_signature:
description: If true, enables external EID signature for the document, allowing recipients to sign using an external Electronic ID provider. Incompatible with is_selfsign.
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: External EID signature
x-ms-visibility: advanced
external_id:
description: External system ID for identification
type: string
x-ms-summary: External ID
external_signature_settings:
description: Optional configuration for external EID signature. Only applicable when external_eid_signature is enabled. EID verification at signing is always required. When verify_recipient_ssn is enabled, the SSN from the EID provider is matched against the recipient's verify_eid_number.
properties:
identification_stages:
description: Stages where additional EID identification is required. Available value is "View" (require EID verification before viewing the document). EID verification at signing is always required.
items:
enum:
- View
type: string
type: array
type: object
x-ms-summary: External signature settings
x-ms-visibility: advanced
file_content:
description: Base64 encoded file content
type: string
x-ms-summary: File content
file_ids:
description: Comma-separated, unique file-ids received when uploading files
type: string
x-ms-summary: File IDs
file_name:
description: Filename of the document, with the extension. This will be helpful for converting different file-types.
type: string
x-ms-summary: File name
file_url:
description: Url to document file. Documents must be public available for download
type: string
x-ms-summary: File URL
is_automatic_sending:
description: If the document should be sent after creation
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Send automatically
x-ms-visibility: important
is_reminder_sending:
description: Should automatic reminders be sent
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Send reminders
x-ms-visibility: advanced
is_scheduled_sending:
description: Should the sending be scheduled for sending in the future
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Schedule sending
x-ms-visibility: advanced
is_signing:
description: Should the document be sent for signing
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Sign document
x-ms-visibility: advanced
is_signing_biometric:
description: Use handwritten signature
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Handwritten signature
x-ms-visibility: advanced
is_signing_forward:
description: Should recipients be able to transfer signature rights
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Allow signature transfer
x-ms-visibility: advanced
is_signing_initials:
description: Sign document using recipient initials
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Sign with initials
x-ms-visibility: advanced
is_sms_sending:
description: Should the document be sent to recipient mobile by text
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Send SMS
name:
description: Enter a name of the document
type: string
x-ms-summary: Document name
x-ms-visibility: important
recipients:
items:
properties:
company_name:
description: Company name of the recipient
type: string
x-ms-summary: Company name
x-ms-visibility: important
company_number:
description: Company number of the recipient
type: string
x-ms-summary: Company number
x-ms-visibility: important
email:
description: Email address of the recipient
type: string
x-ms-summary: Email
x-ms-visibility: important
first_name:
description: Recipient first name
type: string
x-ms-summary: First name
x-ms-visibility: important
fullname:
description: Use to specify full name instead of first/last name
type: string
x-ms-summary: Full name
x-ms-visibility: important
last_name:
description: Last name of recipient
type: string
x-ms-summary: Last name
x-ms-visibility: important
mobile:
description: Mobile phone in international format
type: string
x-ms-summary: Mobile
note:
description: Additional note for a recipient
type: string
x-ms-summary: Note
x-ms-visibility: advanced
order_num:
description: If signing order is enabled
example: 1
format: int32
nullable: true
type: integer
x-ms-summary: Signing order
x-ms-visibility: advanced
role:
description: 'The kind of recipient in the document. Available values:
- signer: signer of the document
- internalApprover: used for internal approval processes and will not appear in the signing certificate
- externalApprover: used for external approval processes and will appear in the signing certificate, alongside other signers
- cc: view only
'
enum:
- signer
- internalApprover
- externalApprover
- cc
type: string
x-ms-summary: Recipient type
x-ms-visibility: important
role_name:
description: The name of the role in a template
type: string
x-ms-summary: Template role
x-ms-visibility: important
settings:
description: Per-recipient signature settings.
properties:
exclude_verified_eid_signature:
description: 'Only applies when the document has external_eid_signature enabled. If true, this recipient may sign with a handwritten signature instead of verifying with a verified EID. Note: the additional non-QES signatures do not degrade the security of the document''s existing QES signatures, but are of a lower assurance level (advanced or SES). Someone inspecting the document may see that it contains non-QES signatures.'
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Exclude verified EID signature
x-ms-visibility: advanced
type: object
x-ms-summary: Recipient settings
x-ms-visibility: advanced
verify_eid:
description: Verify using EID
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Verify EID
x-ms-visibility: advanced
verify_eid_type:
description: EID type to be used for personal verification
type: string
x-ms-summary: EID type
x-ms-visibility: advanced
verify_qna:
description: Should a question be asked
enum:
- true
- false
example: true
nullable: true
type: boolean
x-ms-summary: Enable question
x-ms-visibility: advanced
verify_qna_answer:
description: The answer to question
example: '123456789'
type: string
x-ms-summary: Verification answer
x-ms-visibility: advanced
verify_qna_open:
description: Should question be asked before opening document
enum:
- true
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/getaccept/refs/heads/main/openapi/getaccept-documents-api-openapi.yml