API reference

Audit log API

Every recorded event across signing, sharing and documents — what happened, to what, by whom and from where — as one log you can filter and page through, for a SIEM or a compliance archive.

Create an API key Quick start

Base URL https://xdocs.io/api/v1, with Authorization: Bearer xdk_… on every request. Pagination, rate limits, scopes and error codes are the same for every endpoint and are described once, in how the API behaves.

Audit log

Every recorded event across signing, sharing and documents. This is the evidence trail — what happened, to what, by whom, from where — as opposed to analytics, which is about attention.

GET/api/v1/auditaudit:read

The trail, newest first.

Query parameters

familystring: signing, sharing or documents. Anything else is a 400.
typestring: One event type, e.g. recipient.signed — see GET /audit/types. An unknown one is a 400.
qstring: Matches the description, actor name or actor email.
fromISO 8601 datetime
toISO 8601 datetime
documentIdstring
envelopeIdstring
shareLinkIdstring: One link's history, including after the link was deleted.
limitinteger: Up to 500. Defaults to 100, or 500 with format=csv.
cursorstring: The previous page's nextCursor. Opaque — pass it back unchanged.
formatstring: csv returns the same rows as a file.

Returns

{ data: Event[], nextCursor } — id, type, family, description, actorName, actorEmail, envelopeId, documentId, recipientId, shareLinkId, subject{kind,id,title} (kind is envelope, document, room or link), ipAddress, userAgent, metadata, createdAt

400 An unknown family or type, a date that does not parse, or a cursor that is not valid.

GET/api/v1/audit/typesaudit:read

Every event type the log can hold, grouped by family, for building a filter.

Returns

{ data: { families: [{ id, label }], types: [{ type, family }] } }

← The whole API reference Next: Discovery API →