v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring categories

Gets all categories modified between the start and end date.

This endpoint returns a paged result view of category items modified within a range specified by start and end date.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/categories/views/by-modified

Query parameters

startstring date-time

Provide the date and time of when the last modifications were made to the category items that you want returned. The category items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

endstring date-time

Provide the date and time of when the last modifications were made to the category items that you want returned. The category items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

fieldsstring

Only the category items fields that are specified here are returned for each result. Any category item field is a valid value and can be specified as a comma-separated list. For example, to list the category item fields name and ID, provide the value ID, and name. All category item fields are returned by default.

offsetnumber

Use the offset parameter to specify the number of category items to skip from the beginning of the list and return the rest.

limitnumber

Set the limit for the maximum number of category items to return in a single result. The default value is 50.

orderstring

Specify whether you want the category items to be returned in ascending or descending order. Documents are returned in descending order by default.

Response

List of category items.

limitinteger

The page size.

offsetinteger

The number of items to skip from the beginning of the list.

hrefstring

A link to the current page.

nextstring

A link to the next page. Only shown if a next page exists.

previousstring

A link to the previous page. Only shown if a previous page exists.

Example response

{
  "limit": 50,
  "href": "/authoring/v1/categories?offset=50&limit=50",
  "next": "/authoring/v1/categories?offset=100&limit=50",
  "previous": "/authoring/v1/categories?offset=0&limit=50"
}