Retrieve a content item

GET https://deliver.kontent.ai/:environment_id/items/:item_codename

Retrieve a content item by its codename.

The response size is limited to 2000 items.

Request Params

<div class="callout callout--info">

If the requested content is not available in the specified language variant, the API follows the language fallbacks as configured in the Localization settings.</div>

| | elements | string | | Determines which content elements to retrieve. The elements are specified as a comma-separated list of element codenames. By default, all elements are retrieved.

Examples

• Retrieve a single element – elements=title
• Retrieve multiple elements – elements=title,summary,related_articles

Usage notes

• The filter applies to all content items within the response. That is both the items array and modular_content object property.
• If the specified elements don't match the elements present in the content items, the API returns the content items without any elements.
• The filter doesn't apply to content components. For example, if you retrieve only rich text elements, you need complete components used in the rich text to construct the rich text content. | | excludeElements | string | | Determines which content elements to exclude. The elements are specified as a comma-separated list of element codenames. By default, all elements are retrieved.

Examples

• Exclude a single element – excludeElements=title
• Exclude multiple elements – excludeElements=title,summary,related_articles

Usage notes

• The filter applies to all content items within the response. That is both the items array and modular_content object property.

• If the specified elements don't match the elements present in the content items, the API response returns all elements of the content items without any exclusion.

• The filter doesn't apply to content components. For example, if you retrieve only rich text elements, you need complete components used in the rich text to construct the rich text content. | | depth | string | | Determines the nesting level for linked content items that the API returns. By default, only the first level of linked items is returned, which is the same as setting depth=1.

• To include more than one level of linked items in the response, set depth to 2 or more.

• To exclude all linked items from the response, set depth to 0. 

<div class="callout callout--info">

Components are always present in response. See Linked content and components for more details.</div>

|

HEADERS

The header can be useful if you know that the requested content had changed since your last request in a reaction to a webhook notification. | | Accept | string | | |

RESPONSES

status: OK

{"item":{"system":{"id":"7b11fe14-6282-4daa-b901-e59e231cd93c","name":"How to write error messages","codename":"how_to_error_message","language":"en-US","type":"article","collection":"default","sitemap_locations":[],"last_modified":"2020-12-16T15:08:53.2391808Z","workflow":"default","workflow_step":"published"},"elements":{"title":{"type":"text","name":"Title","value":"Writing good error messages"},"body_copy":{"type":"rich_text","name":"Body","images":{},"links":{},"modular_content":["n78ee300e_7a58_0117_819e_529b2294067b"],"value":"\u003cp\u003eThe 3 most important things when writing error messages\u003c/p\u003e\n\u003col\u003e\n  \u003cli\u003eDon’t abuse alerts for upselling or showing superfluous information. People will stop reading the messages that are actually important.\u003c/li\u003e\n  \u003cli\u003eDon’t just assume people know about the context of a message. They might toggle between apps and see your message days after it happened. Always include enough information for users to make sense of it.\u003c/li\u003e\n  \u003cli\u003eUse a friendly, non-technical, non-threatening tone of voice.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003e\u003cem\u003e\u003cstrong\u003eTL;DR Write actionable error messages that laypeople can understand.*\u003c/strong\u003e\u003c/em\u003e\u003c/p\u003e\n\u003cp\u003e\u003cem\u003e*Not sure if they do? Show them to a non-technical person and ask them to explain it back to you.\u003c/em\u003e\u003c/p\u003e\n\u003cp\u003e\u003cem\u003eRead the full story on \u003c/em\u003e\u003ca href=\"https://medium.com/@thomasfuchs/how-to-write-an-error-message-883718173322\" data-new-window=\"true\" title=\"How to write a great error message\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cem\u003eMedium\u003c/em\u003e\u003c/a\u003e\u003cem\u003e.\u003c/em\u003e\u003c/p\u003e\n\u003cobject type=\"application/kenticocloud\" data-type=\"item\" data-rel=\"component\" data-codename=\"n78ee300e_7a58_0117_819e_529b2294067b\"\u003e\u003c/object\u003e"},"author":{"type":"modular_content","name":"Author","value":["jenny_brown"]},"url":{"type":"url_slug","name":"URL pattern","value":"writing-good-error-messages"}}},"modular_content":{"jenny_brown":{"system":{"id":"59838cfd-ba15-4607-8e6a-d91931fc7ce6","name":"Jenny Brown","codename":"jenny_brown","language":"en-US","type":"author","sitemap_locations":[],"last_modified":"2020-02-05T11:33:54.5271987Z","collection":"default","workflow":"default","workflow_step":"published"},"elements":{"name":{"type":"text","name":"Name","value":"Jenny Brown"},"bio":{"type":"rich_text","name":"Bio","images":{},"links":{},"modular_content":[],"value":"\u003cp\u003eJenny is here for all things wildlife and, newly, climate changes.\u003c/p\u003e"}}},"n78ee300e_7a58_0117_819e_529b2294067b":{"system":{"id":"78ee300e-7a58-0117-819e-529b2294067b","name":"78ee300e-7a58-0117-819e-529b2294067b","codename":"n78ee300e_7a58_0117_819e_529b2294067b","language":"en-US","type":"blockquote","collection":"default","sitemap_locations":[],"last_modified":"2020-12-16T15:08:53.2391808Z"},"elements":{"quote":{"type":"text","name":"Quote","value":"Don't quote me on this."},"source":{"type":"text","name":"Source","value":"Jeff Loomis"}}}}}