API reference

Viewer questions API

Readers can ask a question from inside a shared link without leaving the document. List what was asked and answer it from your own tools; the answer is emailed back to them.

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.

Viewer questions

What readers asked from inside a shared link, and your answers, which are emailed back to them.

GET/api/v1/questionsviews:read

Question threads, those waiting on you first. The two hundred most recently opened; a specific thread is always reachable by id.

Query parameters

awaitingboolean: true for threads where the reader spoke last.
documentIdstring
dataRoomIdstring
shareLinkIdstring
emailstring

Returns

{ data: Thread[] } — id, documentId, dataRoomId, shareLinkId, linkName, about (the document or room title), askedByEmail, awaitingOwner, createdAt, lastMessageAt, messages: [{ id, author, body, createdAt, delivered }], opening question first

GET/api/v1/questions/:idviews:read

One thread, every turn in order.

Returns

{ data: Thread }

POST/api/v1/questions/:id/replylinks:write

Answer in the thread. Emailed to the asker when the link captured an address; delivered says whether it went.

Body (JSON)

bodystringrequired: Up to 5,000 characters.

Returns

{ data: Thread, delivered: boolean } — the reply is kept in the thread whether or not the email went

422 The reply could not be recorded; the message says why.

← The whole API reference Next: File request API →