How To Hide Properties Within Episervers Content Delivery API

Published On Thu 3 December, 2020

In this tutorial, you will learn how to remove properties from appearing in the Episerver content delivery API. If you are using the content delivery API then out-of-the-box it is likely the API will returning a number of properties that the client will never need. To improve performance when returning data from a page, or, blocks using the content delivery API you will restrict Episerver from returning more data than the client needs.

The simplest way to prevent a property some of the content data from being returned from the content delivery API is to use the [JsonIgnore] attribute. If you use reflection and look within the 'ContentModelMapperBase ' you will notice that any property marked with [JsonIgnore] will be ignored.

This means you can simply decorate any property either on a page or block declaration and it will not be returned with the API:

Enjoy!