Search Publications

GET/api/2026-03/publications/search

public-api:read

Latest version (since 2026-01)

ACCESS_TOKEN=ey1234
curl -k -X GET "https://server.livingdocs.io/api/2026-03/publications/search" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Query Parameters

Query String

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

Parameter	Type	Description
`search`	`string`	Search term to perform a full-text search with. For exact word matches use “, e.g. `search=“Ukulele”`
`contentTypes`	`string`	Comma separated list of content-types for which documents should be found. Content types are concatenated with OR. Example: 'regular,author'
`categories`	`string`	Comma separated list of category ids for which documents should be found. Categories are concatenated with OR. Example: 'sport,fashion'
`languages`	`string`	Comma separated list of languages for which documents should be found. Languages are concatenated with OR. Example: 'en,de'
`languageGroupId`	`string`	A GroupId used to fetch all translations of a document. Using the `?languages` param a document in a specific language can be fetched. Example: `?languageGroupId=47&language=de`
`filters`	`string`	A JSON string which follows the Search Filters query DSL
`sort`	`string`	Comma separated list of sort properties. Any of the Sort Fields can be used. The sort order can be reversed by prefixing the property with a `-`
`fields`	`string`	Comma separated list of properties to include in the response. Defaults to `systemdata,metadata,content`. Use `id` if you only want to retrieve the ids of the published documents. Useful (and faster) if you are fully synchronizing your frontend with the publication events
`limit`	`integer`	A limit for how much published documents to retrieve. Defaults to 10. Max. 100
`offset`	`integer`	An offset into the query. Useful when getting more than 100 results (pagination). Max. 10000
`after`	`string`	The `cursor` provided in the response can be passed back for pagination instead of using `offset`.
`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 allows filtering for published documents.

Use Cases

Automatic teaser lists like topic pages (filtered by Metadata properties)
Ticker Tool

warning

Even when it's possible to make a full-text search to this endpoint, it's not thought to be used by a frontend search (because of performance reasons)

Responses

{
  "total": 10,
  "cursor": "eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19",
  "results": [
    {
      "systemdata": {
        "projectId": 1,
        "channelId": 1,
        "documentId": 1,
        "contentType": "article",
        "documentType": "article",
        "design": {
          "name": "timeline",
          "version": "1.1.0"
        }
      },
      "metadata": {
        "title": "Obama re-elected",
        "description": "some lead",
        "dependencies": {},
        "testDependency": "li-test-dependency.onUpdate is correct"
      },
      "content": [
        {
          "id": "doc-1b8i1ksh10",
          "component": "head",
          "identifier": "timeline.head",
          "content": {
            "title": "Obama re-elected",
            "text": "some lead"
          }
        },
        {
          "id": "doc-1b8i1ksh20",
          "component": "normal",
          "identifier": "timeline.normal",
          "content": {
            "caption": "my caption"
          },
          "styles": {
            "position": "left"
          }
        },
        {
          "id": "doc-1b8i1ksh30",
          "component": "p",
          "identifier": "timeline.p",
          "content": {
            "text": "first paragraph"
          }
        },
        {
          "id": "doc-1b8i1me1d0",
          "component": "p",
          "identifier": "timeline.p",
          "content": {
            "text": "second paragraph"
          }
        }
      ]
    }
  ]
}

{
  "total": 1,
  "results": [
    {
      "systemdata": {
        "projectId": 1,
        "channelId": 1,
        "documentId": 1,
        "contentType": "article",
        "documentType": "article",
        "design": {
          "name": "timeline",
          "version": "1.1.0"
        }
      },
      "metadata": {
        "title": "Bayern to win Champions League",
        "description": "some lead",
        "category": {
          "id": "sport"
        },
        "language": {
          "locale": "en"
        },
        "dependencies": {},
        "testDependency": "li-test-dependency.onUpdate is correct"
      },
      "content": [
        {
          "id": "doc-1b8i1ksh10",
          "component": "head",
          "identifier": "timeline.head",
          "content": {
            "title": "Bayern to win Champions League",
            "text": "some lead"
          }
        },
        {
          "id": "doc-1b8i1ksh20",
          "component": "normal",
          "identifier": "timeline.normal",
          "content": {
            "caption": "my caption"
          },
          "styles": {
            "position": "left"
          }
        },
        {
          "id": "doc-1b8i1ksh30",
          "component": "p",
          "identifier": "timeline.p",
          "content": {
            "text": "first paragraph"
          }
        },
        {
          "id": "doc-1b8i1me1d0",
          "component": "p",
          "identifier": "timeline.p",
          "content": {
            "text": "second paragraph"
          }
        }
      ]
    }
  ]
}

{
  "total": 11,
  "results": [
    {
      "systemdata": {
        "projectId": 1,
        "channelId": 1,
        "documentId": 1,
        "contentType": "regular",
        "documentType": "article",
        "design": {
          "name": "timeline",
          "version": "1.1.0"
        }
      },
      "metadata": {
        "title": "Bayern to win Champions League",
        "description": "some lead",
        "category": {
          "id": "sport"
        },
        "language": {
          "locale": "en"
        },
        "dependencies": {},
        "testDependency": "li-test-dependency.onUpdate is correct"
      },
      "content": [
        {
          "id": "doc-1b8i1ksh10",
          "component": "head",
          "identifier": "timeline.head",
          "content": {
            "title": "Bayern to win Champions League",
            "text": "some lead"
          }
        },
        {
          "id": "doc-1b8i1ksh20",
          "component": "normal",
          "identifier": "timeline.normal",
          "content": {
            "caption": "my caption"
          },
          "styles": {
            "position": "left"
          }
        },
        {
          "id": "doc-1b8i1ksh30",
          "component": "p",
          "identifier": "timeline.p",
          "content": {
            "text": "first paragraph"
          }
        },
        {
          "id": "doc-1b8i1me1d0",
          "component": "p",
          "identifier": "timeline.p",
          "content": {
            "text": "second paragraph"
          }
        }
      ]
    }
  ]
}

{
  "total": 2,
  "results": [
    {
      "documentId": 1,
      "projectId": 1
    },
    {
      "documentId": 2,
      "projectId": 1
    }
  ]
}