Sign in

v1

latestOpenAPI 3.0.02026-07-26135449.7 KB

get/v1/studies

Query parameters

qstring

The query string to search for content. If omitted or empty/whitespace-only, the API uses a broad default query.

platform'de' | 'en' | 'en-de'

The platform to search for content. Defaults to en which means English.

offsetinteger

The number of items will be skipped before the first result. The default value for offset is 0. This is useful for pagination. Could be used in combination with size.

sizeinteger

The max. value depends on which API Package you are using. The default value for size is 10. See API-Packages for more information.

An alias for size is limit

pageinteger

The page number to return. The default value for page is 1. This is useful for pagination. Could be used in combination with size.

date_fromstring date-time

The maximum search depth is limited to 20 years from today while the default is 3 months from today. Supported formats are

  • RFC 33939 (%Y-%m-%dT%H:%M:%S like in ISO 8601)
  • %Y-%m-%d %H:%M:%S - example 2024-03-07 12:45:38
  • %d.%m.%Y %H:%M:%S - example 03.07.2024 12:45:38
  • %Y/%m/%d %H:%M:%S - example 2024/03/07 12:45:38
  • %Y-%m-%d - example 2024-03-07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %d.%m.%Y - example 03.07.2024 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %Y/%m/%d - example 2024/03/07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)

The start date to search for content. All content published after this date will be returned. We accept a variety of date formats, e.g. YYYY-MM-DD. For example, 2023-01-01 will return all content published after or on the January 1st, 2023. If not set, we will use 3 months into the past as the default value.

date_tostring date-time

Supported formats are

  • RFC 33939 (%Y-%m-%dT%H:%M:%S like in ISO 8601)
  • %Y-%m-%d %H:%M:%S - example 2024-03-07 12:45:38
  • %d.%m.%Y %H:%M:%S - example 03.07.2024 12:45:38
  • %Y/%m/%d %H:%M:%S - example 2024/03/07 12:45:38
  • %Y-%m-%d - example 2024-03-07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %d.%m.%Y - example 03.07.2024 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %Y/%m/%d - example 2024/03/07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)

The end date to search for content. All content published before this date will be returned. We accept a variety of date formats, e.g. YYYY-MM-DD. For example, 2023-01-01 will return all content published before or on the January 1st, 2023. If not set, the current date is used.

premiumboolean nullable

Filters content based on its premium status. If set to true, only premium content is returned. If set to false, only free content is returned. If not set, both free and premium content is returned.

sort0 | 1

Choose how you want the results to be ordered: 0 – Best match first (sorted by relevance) 1 – Most recent first (sorted by publication date) If omitted, results are ordered by best match.

Response

The request has succeeded.

total_countinteger required

The total number of available items matching the request.

total_pagesinteger

The total number of pages available, based on the selected size parameter