Content Delivery API

Entries

Entries represent anything defined as a Content Type in a space.

Entries can have link fields that point to other entries or assets. You can learn more about links in our concept guide.

Entry object description

Entry object consists of the following top-level properties:

FieldTypeDescription
metadataMetadataUser-controlled metadata.
Note: Currently holds tags and concepts property, which contains lists of tags and taxonomy concepts assigned to an entry, respectively.
sysSysCommon system properties. For detailed description of properties, please refer to Common resource attributes.
fieldsObjectFields that are custom defined by a user through the definition of content types.
fields object in CDA and/or CPA includes locale only when it is specifically requested in an API call or when your content is synchronized via Sync API. Whenever locale is not included, the locale value in the entry object will be returned under the sys.locale property.

Entries collection

In the JSON response of a successful query, linked items are placed in the includes array, when not already fetched in the items array.

Note: Links in the Delivery API will always only resolve to published entries. Unresolved items will not be present in the includes array. The Preview API will include draft entries with the same caveat that unresolved links will not appear in the includes array.

Get all entries of a Space

Entry

The include array is not applicable while retrieving a single entry.

Get an entry

Unresolved entries

When querying an entry collection that contains at least one unresolvable reference (for example, an entry that was referenced by another entry has been deleted, or the referenced entry is Archived or in Draft), an errors array is returned in the response. This also occurs when there are permission issues.

An example of the errors array in the response:

1{
2  "errors": [
3    {
4      "sys": {
5        "id": "notResolvable",
6        "type": "error"
7      },
8      "details": {
9        "type": "Link",
10        "linkType": "Entry",
11        "id": "2bhYOW3HpzPgLPCDdwRrUB"
12      }
13    },
14    {
15      "sys": {
16        "id": "notResolvable",
17        "type": "error"
18      },
19      "details": {
20        "type": "Link",
21        "linkType": "Entry",
22        "id": "Q1GLCTVUJgxsz9gYXFnl4"
23      }
24    }
25  ]
26}