Document Lists

GET/api/2026-03/document-lists/{id}

public-api:read

Latest version

ACCESS_TOKEN=ey1234
curl -k -X GET "https://server.livingdocs.io/api/2026-03/document-lists/{id}?reverse=false&limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Path Parameters

Parameter	Type	Description
`id`*	`integer`

Query Parameters

Query String

Passed as URL query string. Comma-separated values for arrays (e.g. ?contentTypes=regular,author).

Parameter	Type	Description
`reverse`	`boolean`	Pass 'reverse=false' to get the list in the same order as you see it in the editor. (the default is reverse=true for backwards compatibility reasons)
`fields`	`string`	Filters which (comma separated) document properties are included in the response. Defaults to 'systemdata,metadata' also accepts 'content'.
`limit`	`integer`	A limit for how much documents to resolve for the requested list. Defaults to 100. Max. 100.
`ignoreComponentConditions`	`boolean`	(added in release-2024-03) Provides a way to opt out of component filtering and return all content regardless of whether each component passes the conditional checks. Default: `false`
`componentConditions`	`string`	(added in release-2024-03) JSON stringified object which contains the component conditions you would like to apply. Default: `dateTime: new Date()` Example: `?componentConditions={"dateTime":"2024-02-14T17:25:10.391Z"}`

Description

This endpoint resolves the referenced documents in a list.
The response is a JSON object including list information with resolved documents.

Use Cases

Resolve a Document List in the delivery

Responses

{
  "id": 1,
  "name": "List one",
  "documents": [
    {
      "systemdata": {
        "projectId": 1,
        "channelId": 1,
        "documentId": 1,
        "contentType": "article",
        "documentType": "article",
        "design": {
          "name": "timeline",
          "version": "1.1.0"
        }
      },
      "metadata": {
        "title": "a title",
        "description": "some lead",
        "dependencies": {},
        "test": {
          "callCount": 3,
          "message": "li-test called 3 times",
          "events": [
            "onUpdate",
            "onUpdate",
            "onPreparePublish"
          ]
        },
        "testDependency": "li-test-dependency.onUpdate is correct"
      }
    }
  ],
  "createdAt": "2020-11-05T10:55:51.255Z",
  "updatedAt": "2020-11-05T10:55:51.255Z"
}

GET/api/2026-03/document-lists