EaserixDocs
DevelopersAPI referenceSignDocuments

List documents

Documents the caller can read: their own (active-org-scoped; legacy rows without org_id stay visible) plus any shared with the organization by a teammate. Ordered by updated_at descending.

View as Markdown
GET
/v1/documents

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

status?string

Value in

  • "draft"
  • "pending"
  • "completed"
  • "declined"
  • "cancelled"
  • "expired"
scope?string

all (default) — everything readable · mine — only the caller's own · shared — only teammates' org-shared documents (excludes own).

Value in

  • "all"
  • "mine"
  • "shared"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents"
{  "documents": [    {      "id": "string",      "name": "string",      "url": "string",      "status": "string",      "created": "2019-08-24T14:15:22Z",      "modified": "2019-08-24T14:15:22Z",      "size": 0,      "pages": 0,      "templateId": "string",      "hasFile": true,      "hasFinalFile": true,      "signingMode": "string",      "message": "string",      "sentAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "voidedAt": "2019-08-24T14:15:22Z",      "voidReason": "string",      "visibility": "string",      "ownerId": "string",      "requiresNotarization": true,      "notaryState": "string",      "recipients": [        {          "id": "string",          "name": "string",          "email": "string",          "role": "string",          "status": "string",          "orderIndex": 0,          "signedAt": "2019-08-24T14:15:22Z",          "viewedAt": "2019-08-24T14:15:22Z",          "declinedAt": "2019-08-24T14:15:22Z",          "declineReason": "string",          "hasAccessCode": true,          "signature": "string"        }      ],      "fields": [        {          "id": "string",          "type": "signature",          "x": 0,          "y": 0,          "width": 0,          "height": 0,          "page": 0,          "required": true,          "label": "string",          "value": "string",          "recipientId": "string"        }      ]    }  ]}

Liveness probe

Unauthenticated liveness check used by the platform and monitors.

Create a draft

Creates a draft. The PDF is attached separately (POST /v1/documents/{id}/file) and nothing is emailed until /send. With a templateId (public or owned), template fields are copied and — if no recipients were sent — template recipient slots are created with empty emails; template usageCount increments. An unresolvable templateId is a 400. Recipients passed here are created with status "pending".