signing
signatory

List all signatories

Changed on

Returns a list of SigningSignatories. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/signing/{connection_id}/signatory

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/signing/{connection_id}/signatory
  • 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

document_idstring

The document 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 signatory

created_atstring date-time

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

updated_atstring date-time

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

document_idstring

Parent signing document; points to SigningDocument

namestring

Full name of the signatory

emailstring

Email address of the signatory

role'SIGNER' | 'CC' | 'APPROVER' | 'IN_PERSON_SIGNER' | 'VIEWER'

Role of the signatory

status'PENDING' | 'SENT' | 'DELIVERED' | 'SIGNED' | 'DECLINED' | 'ERROR'

Current status of this signatory

ordernumber

Signing order (1, 2, 3...)

signed_atstring date-time

When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

decline_reasonstring

Reason for declining (if status is DECLINED)

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