List all documents

Retrieve a paginated list of all documents in your organization.

Documents can be filtered and sorted. The response includes basic document information and metadata. Use the ‘getDocument’ endpoint to retrieve full document details including signers.

Pagination: Use ‘page’ and ‘perPage’ query parameters to control pagination.

GET /api/v1/documents

List all documents

cURL

curl --request GET \
  --url https://app.sajn.se/api/v1/documents \
  --header 'authorization: <authorization>'

200

{
  "documents": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "documentMeta": {
        "subject": "<string>",
        "message": "<string>",
        "signingOrder": "PARALLEL",
        "forceReadFullDocument": true,
        "showChatToSigners": true,
        "preferredLanguage": "sv",
        "value": "<string>",
        "redirectUrl": "<string>",
        "redirectEnabled": true
      },
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalPages": 123
}

Headers

authorization · string · required

Bearer token for API authentication

Query Parameters

Response

200

application/json

Paginated list of documents

Paginated list of documents

documents · object[] · required

Array of documents

Show child attributes

totalPages · number · required

Total number of pages available