EaserixDocs
DevelopersAPI referenceSignRetention

Documents queued for retention purge

Every document the caller can see (readable scope — owned rows plus the workspace's org-shared ones) currently flagged for deletion (scheduledPurgeAt set), soonest first — the EAS-115 "see what's scheduled before it happens" surface. Sign has no separate admin role today, so this is scoped like every other list, not gated any tighter.

View as Markdown
GET
/v1/documents/scheduled-deletions

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

q?string

Case-insensitive substring match against the document's name.

limit?integer

Page size. Default 10, capped at 100.

offset?integer

Page start. Default 0.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/scheduled-deletions"
{  "documents": [    {      "id": "string",      "name": "string",      "status": "string",      "scheduledPurgeAt": "2019-08-24T14:15:22Z",      "legalHold": true    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Place or lift a legal hold

A hold blocks the EAS-115 retention purge sweep unconditionally, regardless of age, and clears scheduledPurgeAt immediately if the document was already queued. Lifting a hold does not re-queue it — the next sweep tick re-evaluates it like any other document. Owner-scoped, same as void/delete.

The caller's workspace retention policy

No policy configured yet reports the same "keep forever" default a fresh one would (retentionDays: null, graceDays: 14) — a workspace never has to opt in to get default behavior.