Skip to main content
Browse Documentation

Fields list

Created by r.turner, last modified by zengenti on 07 Oct 2021

Specifying entry fields to return

When getting a single entry or a list of entries, the fields returned in the results can be specified using a comma-separated list of field ids:

GET: /api/delivery/projects/movieDb/entries/99aae243-ad6e-401b-89f9-90a51def6a18/?fields=title,synopsis,actors

If no fields are specified then all the data fields and system fields for an entry will be returned.

Data fields

Fields defined in the content type for the entry can be specified by their API id.

System fields

If sys is included in the list of fields, then all system fields will be returned for the entry.

If sys is not included in the list of fields, then the following system fields will be returned:

  • id
  • dataFormat
  • contentTypeId
  • language
  • uri
  • versionStatus

Additional system fields can be specified to be returned by being prefixed with sys., e.g.

GET: /api/delivery/projects/movieDb/entries/99aae243-ad6e-401b-89f9-90a51def6a18/?fields=sys.uri,sys.contentTypeId

The optional system fields that can be specified are:

  • uri
  • projectId
  • contentTypeId
  • metadata
  • properties
  • version
  • owner

It is not possible to specify individual fields within the properties and metadata fields.

Entry title field

The entryTitle field is included then this field will be returned, for example:

GET: /api/delivery/projects/movieDb/entries/99aae243-ad6e-401b-89f9-90a51def6a18/?fields=sys.uri,sys.contentTypeId,entryTitle

Entry description field

The entryDescription field is included then this field will be returned, for example:

GET: /api/delivery/projects/movieDb/entries/99aae243-ad6e-401b-89f9-90a51def6a18/?fields=sys.uri,sys.contentTypeId,entryTitle,entryDescription
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.