signing
document

List all documents

Changed on
get/signing/{connection_id}/document

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/signing/{connection_id}/document
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

statusstring

The status to filter by

template_idstring

The signing template ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this signing document

created_atstring date-time

The date that this signing document was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this signing document was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Document/envelope title

descriptionstring

Message to signers

status'DRAFT' | 'SENT' | 'DELIVERED' | 'IN_PROGRESS' | 'COMPLETED' | 'DECLINED' | 'VOIDED' | 'EXPIRED'

Current status of the signing document

sent_atstring date-time

When sent for signature (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

When all signatures were collected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

expires_atstring date-time

Signing deadline (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

template_idstring

If created from a template; points to SigningTemplate

download_urlstring

URL to download the signed document

creator_idstring

User who created the signing document

rawobject

The raw data returned by the integration

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status