Documents

Get document events

Get a list of document events for a document. On a rejected event, event_meta_data is the reason the recipient gave when rejecting the document, or an empty string when no reason was given. A document with no events returns 204 with no body.

get/v1/documents/{documentId}/events

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/documents/{documentId}/events
  • Auth: HTTP bearer

Path parameters

documentIdstring required

Id of the document.

Response

The request succeeded.

first_namestring nullable required

First name of the person the event belongs to.

last_namestring nullable required

Last name of the person the event belongs to.

emailstring nullable required

Email address of the person the event belongs to.

thumb_urlstring nullable required

Avatar of the person the event belongs to.

company_namestring nullable required

Company of the recipient the event belongs to. On an event log row it falls back to the company name of your entity, and then to the entity name, when the recipient has none or the event is a sender action. On a bounce, click or reminder row it is the company of the recipient, or null when the row has no matching recipient.

event_namestring required

What happened: an event log name such as sent, viewed, signed or rejected; an email bounce status (deferred, hardbounced, queued, softbounced or spamreport); clicked for a clicked field; or sms, video or reminder for a reminder.

document_namestring required

Current name of the document, except on email bounce events, where it holds the reason the email bounced.

document_statusstring required

Current status of the document, the same on every event rather than the status at the time of the event.

event_meta_datastring required

Extra data of the event, which on a rejected event is the reason the recipient gave.

created_atstring required

When the event happened.

document_idstring required

Id of the document the event belongs to.

Changes

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