Document Lists

Get List by Id

Required scope: public-api:read

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

Curl Example

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

Endpoint

GET api/v1/document-lists/:id

Parameters

Name	Type	Required	Notes
:id	integer	x
?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’ (no renditions).
?limit	integer		A limit for how much documents to resolve for the requested list. Defaults to 100. Max. 100.
?ignoreComponentConditions	boolean		Provides a way to opt out of component filtering and return all content regardless of whether each component passes the conditional checks. Added in: `release-2024-03` Default: `false`
?componentConditions	string		JSON stringified object which contains the component conditions you would like to apply. Added in: `release-2024-03` Default: `dateTime: new Date()` Example: `?componentConditions={"dateTime":"2024-02-14T17:25:10.391Z"}`

Response

200

api/v1/document-lists/1

{
  "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 Lists