Skip to Content
Documents

List all documents

GET
/api/v1/documents

Retrieve a paginated list of all documents in your workspace.

Documents can be filtered and sorted. The response includes basic document information and metadata. Use the 'getDocument' endpoint to retrieve full document details including parties and fields.

Pagination: Pass nextCursor from the previous response as cursor until hasMore is false. Pages are keyset-based on every orderBy, so they stay stable while documents change. Documents without a completedAt or expiresAt come last when you sort by that field.

Incremental sync: Filter with updatedAfter set to the newest updatedAt you have stored, sort by updatedAt ascending, and follow the cursor until hasMore is false.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 100. Default: 25.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor from the previous response, to get the next page. Keep the other parameters unchanged.

Length1 <= length <= 2048
include?array<>

total adds the number of items that match the filters. Counting takes time, so ask for it only when you need it.

status?array<>

Filter by document status. Comma-separated or repeated.

tagId?array<string>

Filter by one or more tag IDs. Comma-separated or repeated.

folderId?string

Filter by folder ID. Pass root to include only top-level documents.

templateId?array<string>

Filter by the IDs of the templates the documents were created from. Comma-separated or repeated.

bundleId?string

Returns only the documents in this bundle. folderId is ignored with it.

externalId?string

Returns only the document whose externalId equals this value exactly. For partial matches, use query.

responsibleUserId?array<string>

Filter by responsible user IDs. Comma-separated or repeated.

createdAfter?string

Only documents created at or after this ISO 8601 date or date-time.

createdBefore?string

Only documents created at or before this ISO 8601 date or date-time.

updatedAfter?string

Only documents updated at or after this ISO 8601 date or date-time. Use this for incremental sync.

updatedBefore?string

Only documents updated at or before this ISO 8601 date or date-time.

completedAfter?string

Only documents completed at or after this ISO 8601 date or date-time.

completedBefore?string

Only documents completed at or before this ISO 8601 date or date-time.

query?string

Free-text search across name, externalId, signer name, and signer email

archived?boolean

If true, returns only archived documents. If false, returns only documents that aren't archived. Default: false.

orderBy?string

The field to sort by. Default: createdAt.

Default"createdAt"
Value in"createdAt""updatedAt""name""completedAt""expiresAt"
orderDirection?string

The sort direction. Default: desc.

Default"desc"
Value in"asc""desc"

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Response Body

Paginated list of documents

application/json
  1. response

Paginated list of documents

data*array<>
hasMore*boolean

True if more items follow this page.

nextCursor*|

Pass this as cursor to get the next page. Null on the last page.

total?integer

The number of items that match the filters. Present only with include=total.

Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'https://app.sajn.se/api/v1/documents'
Example Response
{  "data": [    {      "id": "cm4k2x9p10003abcd1234efgh",      "externalId": "HR-2026-0142",      "expiresAt": "2026-10-28T22:00:00.000Z",      "name": "Anställningsavtal – Kai Lindqvist",      "status": "COMPLETED",      "documentMeta": {        "subject": "Ditt anställningsavtal från Exempelbolaget AB",        "message": "Hej Kai! Här är ditt anställningsavtal. Signera det med BankID senast den 28 oktober.",        "signingMode": "PARALLEL",        "forceReadFullDocument": false,        "showChatToSigners": false,        "language": "sv",        "value": "540000",        "redirectUrl": null,        "redirectEnabled": true,        "internalRecipients": [          "hr@example.com"        ],        "signableAfterExpired": false,        "sendPlainTextEmailOnly": false,        "reminderIntervalDays": 3,        "allowDelegation": false,        "openVerification": "PIN",        "aiChatEnabled": false,        "nationalIdDisplayMode": "FULL",        "sameDeviceSigning": false,        "documentCategoryId": "cm4k2x9p10017abcd1234efgh"      },      "createdAt": "2026-09-28T09:12:00.000Z",      "updatedAt": "2026-09-28T09:15:00.000Z",      "completedAt": "2026-09-29T07:41:00.000Z",      "deletedAt": null,      "templateId": "cm4k2x9p10008abcd1234efgh",      "folderId": "cm4k2x9p10011abcd1234efgh",      "responsibleUserId": "cm4k2x9p10002abcd1234efgh",      "parties": [        {          "id": "cm4k2x9p10004abcd1234efgh",          "name": "Kai Lindqvist",          "email": "kai@example.com",          "role": "SIGNER",          "signingStatus": "SIGNED",          "signedAt": "2026-09-29T07:41:00.000Z"        }      ],      "tags": [        {          "id": "cm4k2x9p10010abcd1234efgh",          "name": "Anställning",          "color": "#16A34A"        }      ]    }  ],  "hasMore": false,  "nextCursor": null,  "total": 1}

Was this page helpful?