API reference
A file request asks named people for named documents — the diligence checklist, the onboarding paperwork. Each assignee gets their own upload link, reminders go out on a schedule, and whatever arrives becomes a document, filed where you said.
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.
Ask named people for named documents. Each assignee gets their own upload link, and whatever arrives becomes a document in the workspace, filed where the request says.
/api/v1/requestsrequests:readFile requests, most recently changed first, with progress counts.
Returns
{ data: Request[] } — id, slug, url, title, description, dataRoomId, folderId, requireEmail, dueAt, remindEveryDays, notifyOnUpload, active, closedAt, createdAt, updatedAt, counts{items, assignees, completed, uploads}. url is the open upload page; each assignee is mailed their own.
/api/v1/requests/:idrequests:readThe request with its items, assignees and what has arrived.
Returns
{ data: Request & { items: [{ id, name, description, required, position }], assignees: Assignee[], uploads: [{ id, itemId, assigneeId, uploaderEmail, uploaderName, filename, contentType, byteSize, sha256, documentId, uploadedAt }] } } — an upload is read as the document named by documentId; assignee tokens and storage URLs are never included
/api/v1/requestsrequests:writeAsk for files. Assignees are mailed their own link at once.
Body (JSON)
titlestringrequireddescriptionstringitems{name, description?, required?}[]required defaults to true.dataRoomIdstring | nullfolderIdstring | nulldataRoomId.dueAtISO 8601 datetime | nullremindEveryDaysinteger 1–60 | nullrequireEmailbooleannotifyOnUploadbooleanassignees{email, name?}[]Returns
201 { data: Request & { items[], assignees[], uploads[] } }
404 No such room, or no such folder in it.422 A `folderId` without a `dataRoomId`./api/v1/requests/:idrequests:writeChange any setting. active: false closes it, and the link says so instead of accepting files.
Body (JSON)
…same as POSTtitle, description, dueAt, remindEveryDays, requireEmail, notifyOnUpload and active, all optional. The room, folder, items and assignees are fixed once a request exists.Returns
{ data: Request }
/api/v1/requests/:idrequests:writeDelete the request. Uploads stay: they are documents in the workspace now.
Returns
204
/api/v1/requests/:id/assigneesrequests:writeAdd people and mail each their link. Idempotent per address: somebody already on the request has their name updated and is mailed again rather than added twice.
Body (JSON)
assignees{email, name?}[]requiredReturns
201 { data: Assignee[] } — every assignee on the request: id, email, name, delivery, deliveryError, sentAt, remindedAt, reminderCount, uploadedAt, completedAt, createdAt
/api/v1/requests/:id/assignees/:assigneeIdrequests:writeRemove somebody. Their link stops working; what they already sent stays. Idempotent.
Returns
204
/api/v1/requests/:id/assignees/:assigneeId/resendrequests:writeMail their link again — a fresh invitation if the first never arrived, otherwise a reminder.
Returns
{ data: Assignee, delivered: boolean }
404 No such assignee on this request.