Kontent.ai Learn

Filter content to get what you need

Jan Cerman
9 minutes
Download PDF
0% complete
The Delivery API provides several filters to help you refine your requests based on your requirements. To choose the right one, think about what you know about the content you want to get. There’s a filter for every use case.Find a scenario relevant to you and adjust the code samples to get the content you need.

Filter by item ID or a codename

To get an item based on its identifier (like ID or codename), use the equals filter. For example, if you need to get an item by its internal ID, you match the item's ID (found in system.id) against the ID value you have.
  • TypeScript
// Gets an item by its internal ID
const itemById = await deliveryClient.items()
  .equalsFilter('system.id', '2f7288a1-cfc8-47be-9bf1-b1d312f7da18')
  .toPromise();
Tip: This approach works equally well for other system properties of the content item object. For example, system.workflow_step, system.collection, system.last_modified.
If you have multiple identifiers of a single type (for example, only IDs or codenames) and want to retrieve them in a single request, use the in filter.
  • TypeScript
// Gets three items by their codenames. The codenames are unique per project
const itemsByCodenames = await deliveryClient.items()
  .inFilter('system.codename', ['delivery_api', 'get_content', 'hello_world'])
  .toPromise();
If you know the item's codename, we recommend you retrieve the content item directly for better performance.

Filter by content types

To get items based on a single content type, specify the content type's codename (system.type) using the equals filter.
  • TypeScript
// Gets items based on the type Product
const itemsByType = await deliveryClient.items()
  .equalsFilter('system.type', 'product') // Same as using .type('product')
  .toPromise();
To get items based on multiple content types, specify the content types' codenames using the in filter.
  • TypeScript
// Gets items based on the types Product, Article, and News
const itemsByTypes = await deliveryClient.items()
  .inFilter('system.type', ['product', 'article', 'news'])
  .toPromise();

Filter by date & time and numbers

To get items by a datetime value, you can use one of the comparison filters. This lets you retrieve content modified or released before or after a certain date. The following code shows the filters used on the last content modification date and a date & time element.
  • TypeScript
// Note: Date & time element values are provided by users and stored with minute precision. The system.last_modified value reflects Last content change to an item and is stored with ms precision.
// Gets items modified after April 9 2020, 9 am UTC+0
const itemsModifiedGt = await deliveryClient.items()
  .greaterThanFilter('system.last_modified', '2020-05-09T09:00:00.000000Z')
  .toPromise();

// Gets items released at or after April 9 2020, 7 am UTC+0
const itemsModifiedGte = await deliveryClient.items()
  .greaterThanOrEqualFilter('elements.release_date', '2020-05-09T07:00:00Z')
  .toPromise();

// Gets items modified before April 5 2020 UTC+0. Last match would be at 2020-05-04T23:59:59.
const itemsModifiedLt = await deliveryClient.items()
  .lessThanFilter('system.last_modified', '2020-05-05')
  .toPromise();

// Gets items released at or before April 5 2020 10:30 am UTC+0
const itemsModifiedLte = await deliveryClient.items()
  .lessThanOrEqualFilter('elements.release_date', '2020-05-05T10:30:00Z')
  .toPromise();
Tip: Use the same approach for number elements.

Filter by a range of dates and numbers

To get items based on a date range, you need to specify two datetime values using the range filter.
  • TypeScript
// Note: Date & time element values are provided by users and stored with minute precision. The system.last_modified value reflects Last content change to an item and is stored with ms precision.
// Gets items modified between April 5, 2020 10:30 UTC and April 7, 2020, 7:00 UTC
const itemsByDateRange = await deliveryClient.items()
  .rangeFilter('system.last_modified', '2020-05-05T10:30:00', '2020-05-07T07:00:00')
  .toPromise();
To get items based on a number range, you need to specify two numbers. The numbers can be either integers like 3 or floats like 3.14.
  • TypeScript
// Gets items whose rating is at least 6.5 and at most 9
const itemsByNumberRange = await deliveryClient.items()
  .rangeFilter('elements.product_rating', '6.5', '9')
  .toPromise();

Filter by text and rich text

To get items based on the value of a text or rich text element, you need to specify the value using the equals filter.
 The same approach also applies to custom elements.
  • TypeScript
// Gets items whose Title element value equals to 'Hello World'
const itemsByTitle = await deliveryClient.items()
  .equalsFilter('elements.title', 'Hello World')
  .toPromise();

Filter by taxonomy and multiple choice

To get items tagged with specific taxonomy terms, you need to specify the terms using the contains, any, or all filters.
  • TypeScript
// Note: Filters work with codenames of the tags.
// Gets items tagged with one specific tag
const itemsByTag = await deliveryClient.items()
  .containsFilter('elements.tags', ['kontent_ai'])
  .toPromise();

// Gets items tagged with a list of specific tags
const itemsByAllTags = await deliveryClient.items()
  .allFilter('elements.tags', ['kontent_ai', 'cms'])
  .toPromise();

// Gets items tagged with at least one tag from the list
const itemsByAnyTag = await deliveryClient.items()
  .anyFilter('elements.tags', ['headless', 'cms'])
  .toPromise();
Also works for the multiple choice and custom elementsUse the same approach to get items based on a specific value or values of the multiple choice elements. For custom elements, the contains, any, and all filters work only if the element’s value is a stringified array of strings. For example, "[\"DE\",\"US\",\"UK\"]".

Filter by URL slug

The URL slug element value is stored in the same way as the values of text elements. This means the approach to getting items by a specific URL slug is the same, using the equals filter.
  • TypeScript
// Gets items in default language with the URL slug element equal to 'sample-url-slug'
const itemsByUrlSlug = await deliveryClient.items()
  .equalsFilter('elements.url_slug', 'sample-url-slug')
  .toPromise();
To ensure you get content in a specific language, use the language parameter in your requests.

Filter by parent items

When you link multiple items together using the linked items elements, you can retrieve your items based on their relationships.Examples:
  • Filter by where items are used – You can have a linked items element for navigation. Each linked item represents a navigation item in a hierarchy.
  • Filter by article's author – You can have several articles written by a single author, Jane. Each article has a linked items element named Author, containing a reference to the content item that represents the author Jane.
  • When using Web Spotlight to manage your website content, you can retrieve subpages the same way as your linked items. For example, you can have various insurance-related pages linked in multiple places on your website.
Sign in with your Kontent.ai credentials or sign up for free to unlock the full lesson, track your progress, and access exclusive expert insights and tips!