Fetch Linked Document Fields with the REST API

Here we explore an example that fetches a specific content field from a linked document.

The fetchLinks parameter allows you to retrieve a specific content field from a linked document and add it to the document response object.

Note that this will only retrieve content of the following field types:

  • Color
  • Content Relationship
  • Date
  • Image
  • Key Text
  • Number
  • Rich Text (but only returns the first element)
  • Select
  • Timestamp
  • Title

It is not possible to retrieve the following content field types:

  • Embed
  • GeoPoint
  • Link
  • Link to Media
  • Rich Text (anything other than the first element)
  • Any field in a Group or Slice

The value you enter for the fetchLinks option needs to take the following format:

Copy
fetchLinks={custom-type}.{field}

{custom-type}

The custom type API-ID of the linked document

{field}

The API-ID of the field you wish to retrieve from the linked document

A simple example

The following is an example that uses the fetchLinks parameter.

It shows how to query for the recipe with the uid "perfect-parfait". If the custom type "recipe" has a link to another custom type "author," then you can pull in certain fields from that linked document, in this case the "name" field.

Here are all the required parameters for this query:

is the type "recipe"

q=[[at(document.type,"recipe")]]

has the uid "perfect-parfait"

q=[[at(my.recipe.uid,"perfect-parfait")]]

adds linked field

fetchLinks=author.name

Fetch multiple fields

In order to fetch more than one field from the linked document, you just need to comma separate the desired fields. Here is an example that fetches the fields name and picture from the author custom type.

Copy
fetchLinks=author.name,author.picture