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.
Curl Example
ACCESS_TOKEN=ey1234
curl -k -X GET "https://edit.livingdocs.io/proxy/api/api/v1/document-lists/:id?reverse=false&limit=20" \
  -H "Accept: application/json" \
  -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.

Response

200
OK
api/v1/document-lists/1
{
  "id": 1,
  "name": "List one",
  "documents": [
    {
      "systemdata": {
        "projectId": 1,
        "channelId": 1,
        "documentId": 1,
        "contentType": "article",
        "documentType": "article",
        "layout": "regular",
        "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

Required scope: public-api:read

Description

The response is a JSON array including only document lists without resolving documents.
Curl Example
ACCESS_TOKEN=ey1234
curl -k -X GET "https://edit.livingdocs.io/proxy/api/api/v1/document-lists" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Endpoint

GET api/v1/document-lists

Parameters

Name Type Notes
?name string Filters the result set and allows searching by list name.
?limit integer A limit for how much document lists to retrieve. Defaults to 10. Max. 100.
?offset integer An offset into the query. Useful when getting more than 100 results (pagination).

Response

200
OK
api/v1/document-lists
[
  {
    "id": 1,
    "name": "List one",
    "createdAt": "2020-11-05T10:55:51.255Z",
    "updatedAt": "2020-11-05T10:55:51.255Z"
  },
  {
    "id": 2,
    "name": "List two",
    "createdAt": "2020-11-05T11:09:16.561Z",
    "updatedAt": "2020-11-05T11:09:16.561Z"
  },
  {
    "id": 3,
    "name": "List three",
    "createdAt": "2020-11-05T11:09:37.213Z",
    "updatedAt": "2020-11-05T11:09:37.213Z"
  },
  {
    "id": 4,
    "name": "List four",
    "createdAt": "2020-11-05T11:08:53.765Z",
    "updatedAt": "2020-11-05T11:08:53.765Z"
  }
]