Skip to content

JSON:API integration#

Most subfields are available to the JSON:API module out of the box. The Custom Field JSON:API integration module provides additional normalizers for these more advanced subfields that include extra properties.

JSON:API Custom Field example

Normalizers#

  • string_long
  • entity_reference
  • uri
  • datetime
  • daterange
  • time_range

Dependencies#

  • JSON:API (jsonapi)
  • JSON:API Custom Field (custom_field_jsonapi)
  • (recommended) JSON:API Image Styles (jsonapi_image_styles)

Limitations#

  • No support for JSON:API Extras advanced configuration of subfields.
  • Entity reference subfields are exposed as full entities and do not support the include query parameter or advanced filtering.