Omit from API response

Omitting fields from the API response means that the content cannot be fetched by the Content Delivery API or the Content Preview API, and thus is not available to your end application. These fields are still editable in the entry editor.

One use case would be for fields that are only relevant within the Contentful web app, such as fields that indicate an entry’s status in your workflow. That information does not need to be available in your end application, so why not make things more efficient by leaving it out of the response?

To omit a field from the API response:

  1. Log in to the Contentful web app.

  2. Go to the Content model tab.

  3. Go to the required content type and click to open it. The content type editor is displayed.

  4. Go to the required field and click on the three dots actions menu. Select Omit from API response.

    Omit from API response option

  5. Click Save to apply changes to your content type.

Was this helpful?
add-circle arrow-right remove style-two-pin-marker subtract-circle remove