Content Delivery API

The Get all content types call returns comprehensive information of all the content types available in a particular stack in your account.

When executing the API call, you can add queries to extend the functionality of this API call.

Tip: If any of your content types contains a Global field and you wish to fetch the content schema of the Global field, then you need to pass theinclude_global_field_schema:true parameter. This parameter helps return the Global field's schema along with the content type schema.

To query your content types, under the Query Parameters section, insert a parameter named query and provide the query in JSON format as the value. To learn more about the queries, refer to the Queries section of the Content Delivery API doc.

Note: This API request will return a maximum of 100 content types. To retrieve the next batch of content types, make use of the skip parameter (or refer Pagination for more details).

This call returns information of a specific content type. It returns the content type schema, but does not include its entries.

The Get all global fields request returns comprehensive information of all the global fields available in a particular stack in your organization. If you have nested global fields, it appears in the response.

The Get a single global field request allows you to fetch comprehensive details of a specific global field.

When executing the API call, in the 'URL Parameters' section, provide the unique ID of your global field.

The Get all entries request fetches the list of all the entries of a particular content type. It returns the content of each entry in JSON format.

Additionally, if you wish to fetch the metadata attached to each entry, then you need to pass include_metadata as a query parameter. Set this parameter to true to include the entry metadata along with all entries in the response body.

You will find the entry metadata under the _metadata key in the response. It will be associated with a specific extension UID as follows:

"_metadata": {
    "extensions": {
        "{extension_uid}": [{
            "image_copyrights": "Contentstack Branding",
            "scope": "local"
        }]
    }
}

If an entry is not published in a specific locale, make use of the “include_fallback=true” query parameter to fetch the published content from its fallback locale.

Note: If the fallback language of the specified locale is the master language itself, this parameter won't be applicable.

To include the publish details in the response, make use of the include_publish_details=true parameter. This will return the publishing details of the entry in every environment along with the version number that is published in each of the environments.

You can add other Queries to extend the functionality of this API call. Add a query parameter named query and provide your query (in JSON format) as the value.

When using Delivery Tokens

• Fetches ONLY published content

• Passing the environment as a query parameter is optional but recommended to ensure that the CDN delivers the most recent content

• Locale is optional
  • If no locale is specified, it returns the entry from the master locale
  • If you specify a locale in the query, it returns the latest published version of the localized entry/entries
  • If an entry is not localized, make use of the include_fallback=true query parameter to fetch the published content from its fallback locale

Tip: This request returns only the first 100 entries of the specified content type. Refer to the Pagination section to retrieve the rest of your entries in a paginated form.

The Get a single entry request fetches a particular entry of a content type.

Tip: To get a specific version, refer to the Get a Single Entry management API. This request returns only the latest version.

Additionally, if you wish to fetch the metadata attached to each entry, then you need to pass include_metadata as a query parameter. Set this parameter to true to include the entry metadata along with all entries in the response body.

You will find the entry metadata under the _metadata key in the response. It will be associated with a specific extension UID as follows:

"_metadata": {
    "extensions": {
        "{extension_uid}": [{
            "image_copyrights": "Contentstack Branding",
            "scope": "local"
        }]
    }
}

If an entry is not published in a specific locale, make use of the “include_fallback=true” query parameter to fetch the published content from its fallback locale.

Note: If the fallback language of the specified locale is the master language itself, this parameter won't be applicable.

To include the publish details in the response, make use of the include_publish_details=true parameter. This will return the publishing details of the entry in every environment along with the version number that is published in each of the environments.

Note: To retrieve an entry from a particular branch, provide the branch_uid under the branch header.

You can add other Queries to extend the functionality of this API call. Add a query parameter named query and provide your query (in JSON format) as the value.

When using Delivery Tokens

• Fetches ONLY published content

• Passing the environment as a query parameter is optional but recommended to ensure that the CDN delivers the most recent content

• Locale is optional
  • If no locale is specified, it returns the entry from the master locale
  • If you specify a locale in the query, it returns the latest published version of the localized entry/entries
  • If an entry is not localized, make use of the include_fallback=true query parameter to fetch the published content from its fallback locale

The Get information on embedded RTE objects request returns comprehensive information on all entries and/or assets embedded within the Rich Text Editor field.

If your entry contains a Rich Text Editor field and you wish to fetch the content schema of the items embedded inside the rich text, then you need to pass the include_embedded_items[]=BASE query parameter.

You can view information about the embedded objects under the _embedded_items parameter in the JSON response body.

Note: Contentstack’s Content Delivery SDKs help consume the embedded entries and assets returned in the API response. You can then render the embedded objects on the front end however required.

The Get all entries with defined taxonomies request returns comprehensive information of all the entries that contain taxonomy(ies) available in a particular stack in your organization.

To retrieve entries that match only taxonomy and term UID and belong to a specific content type.

query={
  "taxonomies.taxonomy_uid" : "term_uid",
  "_content_type_uid": "_content_type_uid"
}

Example: If you wish to match entries with the term red from the products content type.

query={
  "taxonomies.color" : "red",
  "_content_type_uid": "products"
}

To retrieve entries that match only taxonomy and term UID and belong to multiple content types.

query={
  "taxonomies.taxonomy_uid" : "term_uid",
  "_content_type_uid": { "$in" : ["_content_type_uid1", "_content_type_uid2"] }
}

Example: If you wish to match entries with the term red from the products or blogs content types.

query={
  "taxonomies.color" : "red",
  "_content_type_uid": { "$in" : ["products", "blogs"] }
}

Note: Refer to the Taxonomy section in Queries for more query filters.

The Get all entry variants retrieves all variants of a given entry and their customizations.

Pass your variant UID(s) or aliases in the x-cs-variant-uid header to get all the variants applied to the entries.

Note: By default you can add up to 3 variant UIDs or aliases (comma-separated) simultaneously. The limit can vary based on your organization plan. The variant UID or alias added first takes priority and will be applied to the base entry fields. For example, if you pass UIDs for Red, Green, and Blue variants in that order, the Red variant will have the highest priority. Sample header request, x-cs-variant-uid: cs6c42daef493fb432, cs7697ce80c9bbcc3e, cs8697ce80c9bbcc4f or x-cs-variant-uid: cs_personalize_0_0, cs_personalize_0_1, cs_personalize_0_2.

You can add other queries to extend the functionality of this API call.

When using Delivery Tokens

• Fetches ONLY published content
• Passing the environment as a query parameter is optional but recommended to ensure that the CDN delivers the most recent content
• Locale is optional
  • If no locale is specified, it returns the entry from the master locale
  • If you specify a locale in the query, it returns the latest published version of the localized entry/entries
  • If an entry is not localized, make use of the include_fallback=true query parameter to fetch the published content from its fallback locale

Tip: This request returns only the first 100 entries of the specified content type. Refer to the Pagination section to retrieve the rest of your entries in a paginated form.

Error Handling

If the number of variants exceeds the configured limit:

• The API processes only up to the allowed limit.
• Pass the show_errors=true query parameter to include an errors array describing the truncation.
• If show_errors is false or not set, the errors key is omitted.

Sample response when the show_errors=true query parameter is passed and allowed variant limit is exceeded:

{
  "entries": [ ... ],
  "errors": [
    {
      "code": "VARIANT_LIMIT_EXCEEDED",
      "message": "x-cs-variant-uid should not be greater than {{your_set_limit}}",
      "details": {
        "provided_count": 7,
        "limit": {{your_set_limit}},
        "applied_count": {{your_set_limit}}
      }
    }
  ]
}

The Get single entry variant request retrieves a single variant entry of a given base entry.

Pass your variant UID(s) or aliases in the x-cs-variant-uid header to get all the variants applied to the entries.

Note: By default you can add up to 3 variant UIDs or aliases (comma-separated) simultaneously. The limit can vary based on your organization plan. The variant UID or alias added first takes priority and will be applied to the base entry fields. For example, if you pass UIDs for Red, Green, and Blue variants in that order, the Red variant will have the highest priority. Sample header request, x-cs-variant-uid: cs6c42daef493fb432, cs7697ce80c9bbcc3e, cs8697ce80c9bbcc4f or x-cs-variant-uid: cs_personalize_0_0, cs_personalize_0_1, cs_personalize_0_2.

You can add other queries to extend the functionality of this API call.

When using Delivery Tokens

• Fetches ONLY published content
• Passing the environment as a query parameter is optional but recommended to ensure that the CDN delivers the most recent content
• Locale is optional
  • If no locale is specified, it returns the entry from the master locale
  • If you specify a locale in the query, it returns the latest published version of the localized entry/entries
  • If an entry is not localized, make use of the include_fallback=true query parameter to fetch the published content from its fallback locale

Tip: This request returns only the first 100 entries of the specified content type. Refer to the Pagination section to retrieve the rest of your entries in a paginated form.

Error Handling

If the number of variants exceeds the configured limit:

• The API processes only up to the allowed limit.
• Pass the show_errors=true query parameter to include an errors array describing the truncation.
• If show_errors is false or not set, the errors key is omitted.

Sample response when the show_errors=true query parameter is passed and allowed variant limit is exceeded:

{
  "entries": [ ... ],
  "errors": [
    {
      "code": "VARIANT_LIMIT_EXCEEDED",
      "message": "x-cs-variant-uid should not be greater than {{your_set_limit}}",
      "details": {
        "provided_count": 7,
        "limit": {{your_set_limit}},
        "applied_count": {{your_set_limit}}
      }
    }
  ]
}

The Get all assets request fetches the list of all the assets of a particular stack. It returns the content of each asset in JSON format. You can also specify the environment of which you want to get the assets.

Additionally, if you wish to fetch the metadata attached to each asset, then you need to pass include_metadata as a query parameter. Set this parameter to true to include the asset metadata along with all assets in the response body.

You will find the entry metadata under the _metadata key in the response. It will be associated with a specific extension UID as follows:

"_metadata": {
    "extensions": {
        "{extension_uid}": [{
            "image_copyrights": "Contentstack Branding",
            "scope": "local"
        }]
    }
}

If an asset is not published in a specific locale, make use of the include_fallback=true query parameter to fetch the published version from the fallback locale.

You can apply Queries to filter assets/entries. Add a query parameter named query and provide your query (in JSON format) as the value.

When using Delivery Tokens

• Fetches ONLY published assets
• Environment is mandatory to fetch assets published on the specified environment
• Version is optional
  • If no version is specified, it fetches the latest published version
  • If a version is specified and if it is not the latest published version, it will not return any result
• Locale is optional
  • If no locale is specified, it returns the asset from the master locale
  • If you specify a locale in the query, it returns the latest published version of the localized asset/assets
  • If an asset is not localized, make use of the include_fallback=true query parameter to fetch the published asset from its fallback locale

The Get a single asset request fetches the latest version of a specific asset of a particular stack.

Tip: If no version is mentioned, the request will retrieve the latest published version of the asset. To get a specific version of an asset, refer to the Get a Single Asset management API.

Additionally, if you wish to fetch the metadata attached to each asset, then you need to pass include_metadata as a query parameter. Set this parameter to true to include the asset metadata along with all assets in the response body.

You will find the entry metadata under the _metadata key in the response. It will be associated with a specific extension UID as follows:

"_metadata": {
    "extensions": {
        "{extension_uid}": [{
            "image_copyrights": "Contentstack Branding",
            "scope": "local"
        }]
    }
}

If an asset is not published in a specific locale, make use of the include_fallback=true query parameter to fetch the published version from the fallback locale.

When using Delivery Tokens

• Fetches ONLY published asset
• Environment is mandatory to fetch an asset published on the specified environment
• Version is optional
  • If no version is specified, it fetches the latest published version
  • If a version is specified and if it is not the latest published version, it will not return any result
• Locale is optional
  • If no locale is specified, it returns the asset from the master locale
  • If you specify a locale in the query, it returns the latest published version of the localized asset
  • If an asset is not localized, make use of the include_fallback=true query parameter to fetch the published asset from its fallback locale

The Initial Sync request syncs the entries and assets of a stack, published on a specific environment.

Set init to ‘true’ if you want to sync all the published entries and assets. This is usually used when the app does not have any content and you want to get all the content for the first time.

Note: When executing the API request, pass the Delivery Token as the value to the access_token parameter.

Applicable parameters:

Note: If you specify any value for content_type_uid, locale, start_from, or type, the values for these parameters will remain unchanged for all subsequent sync requests.

Once you perform an initial sync, you will either get a sync_token or a pagination_token in response. These tokens don't have an expiry time.

You can use the sync_token later to perform subsequent sync, which fetches only new changes through delta updates.

If there are more than 100 records, you get a pagination_token in response. This token can be used to fetch the next batch of data. Read Sync using pagination token for more details.

When running the Initial Synchronization or the Subsequent Sync request, if the result of the sync (initial or subsequent) request exceeds 100 records you will get a pagination_token.

The Sync using pagination token request uses the pagination_token to retrieve the next batch of data (100 records) while performing the sync. You can reiterate the process until you get a sync_token.

Note: When executing the API request, pass the Delivery Token as the value to the access_token parameter.

The Subsequent Sync request is used to retrieve the updated content (i.e., published or unpublished content, or any published content that has been deleted) since the last performed complete Sync.

In this API request, you need to provide the sync_token that you received in the last complete sync process. If there are more than 100 records, you will get a pagination_token instead. This token can be used to fetch the next batch of data. Refer the Sync using pagination token section for more details.

Tip: Once you have performed the Initial Sync process, you do not need to perform it again. For retrieving the subsequent delta changes, use the sync_token received either in the Initial Sync process or the previous Subsequent Sync requests to sync new changes. Also, when executing the API request, pass the Delivery Token as the value to the access_token parameter.

Get all entries for a specific taxonomy that satisfy the given conditions provided in the "$in" query.

Your query should be as follows:

query={"taxonomies.taxonomy_uid" : { "$in" : ["term_uid1" , "term_uid2" ] }}

Example: If you want to retrieve entries with the color taxonomy applied and linked to the term red and/or yellow.

query={"taxonomies.color" : { "$in" : ["red" , "yellow" ] }}

OR Operator [Taxonomy]

Get all entries for a specific taxonomy that satisfy at least one of the given conditions provided in the “$or” query.

Your query should be as follows:

query={
  "$or": [
    { "taxonomies.taxonomy_uid_1" : "term_uid1" },
    { "taxonomies.taxonomy_uid_2" : "term_uid2" }
  ]
}

Example: If you want to retrieve entries with either the color or size taxonomy applied and linked to the terms black and small, respectively.

query={
  "$or": [
      { "taxonomies.color" : "black" },
      { "taxonomies.size" : "small" }
    ]
}

AND Operator [Taxonomy]

Get all entries for a specific taxonomy that satisfy all the conditions provided in the “$and” query.

Your query should be as follows:

query={
  "$and": [
    { "taxonomies.taxonomy_uid_1" : "term_uid1" },
    { "taxonomies.taxonomy_uid_2" : "term_uid2" }
  ]
}

Example: If you want to retrieve entries with the color and category taxonomies applied and linked to the terms black and mobile, respectively.

query={
  "$and": [
      { "taxonomies.color" : "black" },
      { "taxonomies.category" : "mobile" }
    ]
}

Exists Operator

Get all entries for a specific taxonomy that if the value of the field, mentioned in the condition, exists.

Your query should be as follows:

query={"taxonomies.taxonomy_uid" : { "$exists": true }}

Example: If you want to retrieve entries with the color taxonomy applied.

query={"taxonomies.color" : { "$exists": true }}

Equal and Below Operator

Get all entries for a specific taxonomy that match a specific term and all its descendant terms, requiring only the target term and a specified level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

query={
  "taxonomies.taxonomy_uid" : { "$eq_below": "term_uid", "levels" : 2}
}

Example: If you want to retrieve all entries with terms nested under blue, such as navy blue and sky blue, while also matching entries with the target term blue.

query={
  "taxonomies.color" : { "$eq_below": "blue" }
}

Below Operator

Get all entries for a specific taxonomy that match all of their descendant terms by specifying only the target term and a specific level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

query={
  "taxonomies.taxonomy_uid" : { "$below": "term_uid", "levels" : 2}
}

Example: If you want to retrieve all entries containing terms nested under blue, such as navy blue and sky blue, but exclude entries that solely have the target term blue.

query={
  "taxonomies.color" : { "$below": "blue" }
}

Equal and Above Operator

Get all entries for a specific taxonomy that match a specific term and all its ancestor terms, requiring only the target term and a specified level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

query = {
  "taxonomies.taxonomy_uid": { "$eq_above": "term_uid", "levels": 2 }
}

Example: If you want to obtain all entries that include the term navy_blue and its parent term blue.

query = {
  "taxonomies.color": { "$eq_above": "navy_blue"}
}

Above Operator

Get all entries for a specific taxonomy that match only the parent term(s) of a specified target term, excluding the target term itself. You can also specify a specific level.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

query = {
  "taxonomies.taxonomy_uid": { "$above": "term_uid", "levels": 2 }
}

Example: If you wish to match entries with all the terms above the target term navy_blue, excluding navy_blue itself.

query = {
  "taxonomies.color": { "$above": "navy_blue" }
}

Get entries containing the field values matching the condition in the query.
This query will work for both entries as well as assets.

Example: In the Products content type, you have a field named Title ("uid":"title") field. If, for instance, you want to retrieve all the entries in which the value for the Title field is 'Redmi 3S', you can set the parameters as:

{"title": "Redmi 3S"}

Let’s consider another example. You want to retrieve all the entries that have their start date as 8th December, 2017. Now, you need to set this parameter with the date in the ISO Date format as below:

{ "start_date": "2017-12-08T00:00:00.000Z" }

This will give you all the entries where the start date is 8th December, 2017.

Equals Operator Within Group

Get entries where the value of a field within a Group field matches the condition in the query. This query is specifically for fields that are part of the Group field.

This query will work for entries only.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Card Type ("uid":"card_type"). If, for instance, you want to retrieve the entries in which the value for the Card Type field is 'Debit Card', you can use the following value in the ‘query’ parameter:

{"bank_offers.card_type": "Debit Card"}

Equals Operator Within Modular Blocks

Get entries where the value of a field within a Modular Blocks field matches the condition in the query. This query is specifically for fields that are part of the Modular Blocks field.

This query will work for entries only.

Example: In the Products content type, we have a Modular Blocks field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") block. And, within this Deals block, we have a field named Deal Name ("uid":"deal_name"). If, for instance, you want to retrieve the entries in which the value for the Deal Name field is 'Christmas Deal', you can use the following value in the query parameter:

{"additional_info.deals.deal_name": "Christmas Deal"}

Get all the entries in which the value of a field does not match the value provided in the condition.

This query will work for both entries as well as assets.

Example: In the Product content type, you have a field named Price in USD. Now, you need to retrieve all entries where the value of this field not equal to '146' for this field. The parameter can be used as:

{ "price_in_usd": { "$ne": 146 } }

This will give you all the entries that have the value for Price in USD not set to '146'.

Let’s consider another example. You want to retrieve all the entries except the ones that have their start date as 8th December, 2017. Now, you need to set this parameter with the date in the ISO Date format as below:

{ "start_date": { "$ne": "2017-12-08T00:00:00.000Z" } }

This will give you all the entries where the start date is not 8th December, 2017.

Not-equals Operator Within Group

Get entries where the value of a field does not match the value provided in the condition. This query is specifically for fields that are part of the Group field.

This query will work for entries only.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Card Type ("uid":"card_type"). If, for instance, you want to retrieve the entries in which the value for the Card Type field is NOT 'Debit Card', use the following value in the query parameter:

{"bank_offers.card_type": {"$ne": "Debit Card"}}

Not-equals Operator Within Modular Blocks

Get entries where the value of a field within the Modular Blocks field does not match the condition in the query. This query is specifically for fields that are part of any block within a Modular Block field.

This query will work for entries only.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") block. And, within this Deals block, we have a field named Deal Name ("uid":"deal_name"). If, for instance, you want to retrieve the entries in which the value for the Deal Name field is NOT 'Christmas Deal', use the following value in the query parameter:

{"additional_info.deals.deal_name": {"$ne": "Christmas Deal"}}

Get entries in which the value of a field matches to any of the given values. This parameter will compare field values of entries to that of the values provided in the condition.
This query will work for entries only.

Example: In the Product content type, you have a field named Price in USD. Now, you need to retrieve all the entries where value of this field is one among the given set of values. The query fired using the '$in' parameter is given below:

{ "price_in_usd": { "$in": [ 101, 749 ] } }

This will retrieve all the entries that have the value of Price in USD field set to '101' or 749'.

Array Equals Operator Within Group

Get entries where the value of a field, within a Group field, matches any of the given values. This parameter will compare field values of entries to that of the values provided in the condition. This query is specifically for fields that are part of the Group field.

This query will work for entries only.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Card Type ("uid":"card_type"). If, for instance, you want to retrieve the entries in which the values for the Card Type field are ‘Credit Card’ and 'Debit Card', use the following value in the query parameter:

{"bank_offers.card_type": {"$in": ["Credit Card", "Debit Card"]}}

Array Equals Operator Within Modular Blocks

Get entries where the value of a field within Modular Blocks matches to any of the given values. This query is specifically for fields that are part of any block within a Modular Block field.

This query will work for entries only.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") block. And, within this Deals block, we have a field named Deal Name ("uid":"deal_name"). If, for instance, you want to retrieve the entries in which the values for the Deal Name field are 'Christmas Deal’ and ‘Summer Deal', use the following value in the query parameter:

{"additional_info.deals.deal_name": {"$in": ["Christmas Deal", "Summer Deal"]}}

Get all entries in which the value of a field does not match to any of the given values. This parameter will compare field values of entries to that of the values provided in the condition, and the query will retrieve entries that have field values that does not match to any of the values provided.

This query will work for entries only.

Example: In the Product content type, you have a field named Price in USD. Now, you need to retrieve the entries where the field value does not fall in the given set. You can send the parameter as:

{ "price_in_usd": { "$nin": [ 101, 749 ] } }

This will give you all the entries that do not have the value for Price in USD set to '101' or '749'.

Array Not-equals Operator Within Group

Get entries in which the value of a field does not match any of the values provided in the condition. This query is specifically for fields that are part of the Group field.
This query will work for entries only.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Card Type ("uid":"card_type"). If, for instance, you want to retrieve the entries in which the values for the Card Type field are NOT 'Debit Card', use the following value in the query parameter:

{"bank_offers.card_type": {"$nin": ["Debit Card"]}}

Array Not-equals Operator Within Modular Blocks

Get entries where the values of the fields within Modular Blocks does not match the condition in the query. This query is specifically for fields that are part of any block within a Modular Block field.
This query will work for entries only.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") block. And, within this Deals block, we have a field named Deal Name ("uid":"deal_name"). If, for instance, you want to retrieve the entries in which the values for the Deal Name field are NOT 'Christmas Deal’ and ‘Summer Deal', use the following value in the query parameter:

{ "additional_info.deals.deal_name": { "$nin": [ "Christmas Deal", "Summer Deal" ] } }

When fetching an entry, the content of referred entries that are part of the parent entry is NOT included in the Response body; you only get their UIDs. To include the content of the referred entries in your response, you need to use the include[] parameter and specify the UID of the reference field as value.The API request should be as follows: https://cdn.contentstack.io/v3/content_types/product/entries?include[]={reference_field_UID. This query will work for entries only.

Example: In the Product content type, there is a reference field called Categories, which refers entries of another content type. Let’s assume that you had created an entry for the Product content type, and the value selected in the Categories field was ‘Mobiles’. If you fetch the entry using the Get a Single Entry API request, you would get all the details of the entry in the response, but the value against the Categories field would be UID of the referenced entry (i.e., UID of the ‘Mobiles’ entry in this case).

In order to fetch the details of the entry used in the Categories reference field, you need to use the include[] parameter in the following manner:

https://cdn.contentstack.io/v3/content_types/product/entries?include[]=categories

In case you wish to fetch the data of the entries of multiple reference fields, use the include[] parameter in the following manner:

https://cdn.contentstack.io/v3/content_types/product/entries?include[]=categories&include[]=brands

Include Reference Within Group

If the reference field is part of a Group field, you need to use the Group field UID as well as the reference field UID using a dot operator.

This query will work for entries only.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a Reference field named Bank ("uid":"bank"). If, for instance, you want to retrieve entries and include the data of the reference field as well, you need to use the include[] parameter in the following manner:

https://cda.contentstack.io/v3/content_types/product/entries?include[]=bank_offers.bank

Include Reference for Nested Referenced Field

In case the referenced entry further has reference to another entry (nested referencing), you can use the dot operator to fetch the content of the nested references as well.
This query will work for entries only.

Example: Consider that you have a content type named ‘Blogs’ which has two reference fields (‘Authors’ and ‘Related Articles’) referring to the ‘Authors’ and ‘Blogs’ content types (self-referencing), respectively. So, we have the following reference relationships between the content types:

• ‘Blogs’ refers to ‘Author’ content type
• ‘Blogs’ refers to ‘Blogs’ content type (self-referencing)

Now, consider that you want to retrieve an entry of the ‘Blogs’ content type along with the data of the author (details from the ‘Author’ content type) who authored the entry. You also want to fetch the data of the authors who wrote the ‘Related Articles’ as well that are referenced in this entry, (details from the ‘Blogs’ content type).

In this case, you need to use related_articles.authors in the include[] parameter as follows:

https://cdn.contentstack.io/v3/content_types/content_type_uid/entries?include[]=authors&include[]=related_articles.authors

Include Reference Within Modular Blocks

If the reference field is part of a Modular Blocks field, you need to use the Modular Blocks UID, Block UID, as well as the reference field UID using a dot operator.

This query will work for entries only.

Example: In the Products’ content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Related Products ("uid":"related_products") block. And, within this Block field, we have a field named Products ("uid":"products"). If, for instance, you want to retrieve entries and include the data of the reference field, you need to use the include[] parameter in the following manner:

https://cda.contentstack.io/v3/content_types/product/entries?include[]=additional_info.related_products.products

When fetching an entry or a list of entries, the referenced entries are not included in the response by default—you only get their UIDs.

To retrieve the content of referenced entries (up to depth 1), use the include_all=true parameter. To fetch deeper references, use the include_all_depth parameter to specify the depth (up to 5 levels).

Each level reflects a reference chain—for example, an entry referencing a blog (level 1), which references articles (level 2), and further, articles linking to authors (level 3).

Example API Request:

https://cdn.contentstack.io/v3/content_types/home/entries/?include_all=true&include_all_depth=3

Get entries having values based on referenced fields. This query retrieves all entries that satisfy the query conditions made on referenced fields.
This query will work for entries only.

Example: In the Product content type, if you wish to retrieve all entries that have their brand (Reference field) title set to Apple Inc. So, the query that needs to be run is given below:

{"brand": { "$in_query": { "title": "Apple Inc."}}}

If you have enabled multiple content type referencing, you need to mention the content type UID of the parent content type as follows:

{"brand":{"$in_query":{"title":"Apple Inc.", "_content_type_uid":"brand"}, "_content_type_uid":"product"}}

You can use queries within this query (nested querying) in order to query on the referred entries. In this case, the syntax of the query will be as follows:

• General query: {"reference_field_uid":{"$in_query":{"referred_content_type's_field_uid":{"query_to_be_applied"}}}}
• Multiple content type reference query: {"reference_field_uid":{"$in_query":{"referred_content_type's_field_uid":{"query_to_be_applied"}}}, "_content_type_uid":"UID_of_referred_content_type"}

Additionally, to retrieve entries that also include references to entries of multiple content types, you need to specify the content type UIDs of all the referred entries when querying.

For example, “Parent Reference” has a Reference field that points to “Reference content type 1” and “Reference content type 1” has a Reference field that points to both “Reference content type 2” and “Reference content type 3”.

So, to retrieve an entry in “Parent Reference” that has referred to an entry of “Reference content type 1” whose Reference field has referred an entry titled “Sample” of “Reference content type 2”. The query format is as follows:

• General query: {"referred_parent_content_type_field_uid": {"$in_query": {"referred_content_type_2_field_uid": { "$in_query": {"title": "Sample"}}}}}
• Multiple content type reference query: {"referred_parent_content_type_field_uid": {"$in_query": {"referred_content_type_2_field_uid": { "$in_query": {"title": "Sample", "_content_type_uid": "referred_content_type_3_uid"} }, "_content_type_uid": "referred_content_type_2_uid"}, "_content_type_uid": "referred_parent_content_type_uid"}}

Reference Search Equals for Nested Querying

You can use queries within this query (nested querying) in order to query on the referred entries.This query will work for entries only.

The syntax of the query will be as follows:

• General query: {"reference_field_uid": { "$in_query": { "referred_fieldname": {"query_to_be_applied"}}}}
• Multiple content type referencing query: {"reference_field_uid": { "$in_query": { "referred_fieldname": {"query_to_be_applied"}}, "_content_type_uid ":"UID_of_parent_content_type"}}

Example: If you want to retrieve all entries that have referenced entries with title that starts with ‘S’ within the frequently_bought_together field, you need to run the query given below:

• General query: {"frequently_bought_together": {"$in_query": {"title": {"$regex": "^s", "$options": "i"}}}}
• Multiple content type referencing query: {"frequently_bought_together": {"$in_query": {"title": {"$regex": "^a", "$options": "i"}, "_content_type_uid": "electronics"}, "_content_type_uid": "kitchen_appliances"}}

In the above query, ‘Search by Regex’ query has been applied on the referred field. Other queries that can be applied are: Equals Operator, Equals Within Group Operator, Not-equals Operator, Array Equals Operator, Array Not-equals Operator, AND Operator, OR Operator, Less Than, Less Than Or Equal To, Greater Than, Greater Than Or Equal To, and Exists.

Reference Search Equals Within Group

Get entries having values based on referenced fields. This query retrieves all entries that satisfy query conditions made on referenced fields.

If the reference field is part of a Group field, you need to mention the Group field UID as well as the reference field UID using a dot operator, as given below.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a Reference field named Bank ("uid":"bank"). If, for instance, you want to retrieve the entries in which the value for the Bank field is ‘Citigroup,’ use the following value in the query parameter:

• General query: {"bank_offers.bank": {"$in_query": { "title": "Citigroup"}}}
• Multiple content type referencing query: {"bank_offers.bank":{"$in_query":{"title":"Wells Fargo", "_content_type_uid": "bank"} , "_content_type_uid": "blog"}}

Reference Search Equals Within Modular Blocks

Get entries having values based on referenced fields. This query retrieves all entries that satisfy query conditions made on referenced fields.If the reference is part of a Modular Blocks field, you need to mention the Modular Blocks UID, Block UID, as well as the reference field UID using a dot operatorNote that this query will work for entries only.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Related Products ("uid":"related_products") block. And, within this Related Products block, we have a field named Products ("uid":"products"). If, for instance, you want to retrieve the entries in which the values for the Title field is iPhone 7 128GB, use the following value in the ‘query’ parameter:

• General query: {"additional_info.related_products.products": {"$in_query": { "title": "iPhone 7 128GB"}}}
• Multiple content type referencing query: {"additional_info.related_products.products":{"$in_query":{"title":"iPhone 7 128GB", "_content_type_uid": "product"}, "_content_type_uid": "electronics"}}

Get entries having values based on referenced fields. This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.

Note that this query will work for entries only.

Example: Let’s say you wish to retrieve all entries that have brand names other than Apple Inc. So, the query that needs to be made is given below:

• General query: {"brand": {"$nin_query": {"title": "Apple Inc."}}}
• Multiple content type referencing query: { "brand": {"$nin_query": {"title": "Apple Inc.", "_content_type_uid": "UID_of_referred_content_type"}, "_content_type_uid": "UID_of_parent_content_type"}}

Note: When querying on Reference field, users need to specify the Content Type UID (using the_content_type_uid parameter) of entry to which the Reference field belongs to.

Reference Search Not-equals Within Group

Get entries having values based on referenced fields. This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.Note that this query will work for entries only.If the reference is part of a Group field, you need to use the Group field UID as well as the reference field UID using a dot operator.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a Reference field named Bank ("uid":"bank"). If, for instance, you want to retrieve the entries in which the value for the Bank field is NOT ‘Citigroup', use the following query:

• General query: {"bank_offers.bank": {"$nin_query": {"title": "Citigroup"}}}
• Multiple content type query: {"bank_offers.bank": {"$nin_query": {"title": "Citigroup", "_content_type_uid": "UID_of_referred_content_type"}, "_content_type_uid": "UID_of_parent_content_type"}}

Reference Search Not-equals Within Modular Blocks

Get entries having values based on referenced fields. This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.

Note: This query will work for entries only.

If the reference is part of a Modular Blocks field, you need to use the Modular Blocks UID, Block UID, as well as the reference field UID using a dot operator.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Related Products ("uid":"related_products") block. And, within this Block field, we have a field named Products ("uid":"products"). If, for instance, you want to retrieve the entries in which the value for the Title field is NOT ‘iPhone 7 128GB', use the following query:

• General query: { "additional_info.related_products.products": {"$nin_query": {"title": "iPhone 7 128GB"}}}
• Multiple content type referencing query: { "additional_info.related_products.products": {"$nin_query": {"title": "iPhone 7 128GB", "_content_type_uid": "UID_of_referred_content_type"}, "_content_type_uid": "UID_of_parent_content_type"}}

Get entries by using regular expressions to query fields of a content type. These regex queries will help to retrieve all the entries of a content type that have field values matching the condition provided in the query parameter.This query will work for both entries as well as assets.

Example: In the Product content type, you have a field named Color ("uid":"color") in your content type, and you want to retrieve all the entries within this content type that have values for this field starting with 'Bl'. You can use the parameter as:

{ "color": { "$regex": "^Bl" } }.

Now, in order to perform a case-insensitive search, you can use the $options key to specify any regular expressions options: 

{ "color": { "$regex": "^bl", "$options": "i" } }.

Tip: Some useful values for $options are m for making dot match newlines and x for ignoring whitespace in regex.

Search by Regex Within Group

Get entries by using regular expressions to query fields of a Group field. These regex queries will help to retrieve all the entries of a content type that have field values matching the condition provided in the query parameter.

Note: This query is specifically for fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a Reference field named Bank ("uid":"bank"). If, for instance, you want to retrieve the entries in which the value for the Card Type starts with “Credit Card,” use the following value in the query parameter:

{ "bank_offers.card_type": { "$regex": "^Credit Card" } }

Search by Regex Within Modular Blocks

Get entries by using regular expressions to query fields of a Modular Block. These Regex queries will help to retrieve all the entries of a content type that have field values matching the condition provided in the query parameter.

This query will work for entries only and works specifically for fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") block. And, within this Deals block, we have a field named Deal Name ("uid":"deal_name"). If, for instance, you want to retrieve the entries where Deal Name starts with “Christmas Deal,” use the following value in the query parameter:

{ "additional_info.deals.deal_name": { "$regex": "^Christmas Deal" }}

Get entries that satisfy all the conditions provided in the '$and' query.This query will work for both entries as well as assets.

Example: Let’s say you want to retrieve entries in which the Title field is set to 'Redmi Note 3' and the Color field is 'Gold'. The query to be used for such a case would be:

{"$and":[{"title": "Redmi Note 3"},{"color": "Gold"}]}

The response will contain the entries where the values for Title is 'Redmi Note 3' and Color is 'Gold'.

AND Operator Within Group

Get entries that satisfy all the conditions provided in the $and query.This query is specifically for entries and works on fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have fields named Card Type ("uid":"card_type") and Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve the entries in where the value for Card Type is ‘Credit Card’ and ‘Discount in Percentage’ is '12', use the following value in the query parameter:

{"$and":[{"bank_offers.card_type": "Credit Card"},{"bank_offers.discount_in_percentage": 12}]}

AND Operator Within Modular Blocks

Get entries that satisfy all the conditions provided in the $and query.This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") and Rating ("uid":"rating") blocks. And, within the Deals and Rating blocks, we have the Deal Name ("uid":"deal_name") and Stars ("uid":"stars") fields, respectively. If, for instance, you want to retrieve the entries in where the values for Deals and Ratings fields are ‘Christmas Deal’ and '2', respectively, use the following value in the query parameter:

{"$and":[{"additional_info.deals.deal_name": "Christmas Deal"},{"additional_info.rating.stars": 2}]}

Get all entries that satisfy at least one of the given conditions provided in the '$or' query.

This query will work for both entries as well as assets.

Example: Let’s say you want to retrieve entries in which either the value for the Color field is 'Gold' or 'Black'. The query to be used for such a case would be:

{ "$or": [{ "color": "Gold" }, { "color": "Black" }] }

The response will contain the entries that have their Color fields set to either 'Gold' or 'Black'.

OR Operator Within Group

Get all entries that satisfy at least one of the given conditions provided in the $or query.

This query is specifically for entries and works for fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have fields named Card Type ("uid":"card_type") and Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve the entries where either the value for Card Type is ‘Debit Card’ or the value for Discount in Percentage is '12', use the following value in the query parameter:

{ "$or": [{ "bank_offers.card_type": "Debit Card" }, { "bank_offers.discount_in_percentage": 12}]}

OR Operator Within Modular Blocks

Get all entries that satisfy at least one of the given conditions provided in the '$or' query.

This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Example: In the ‘Products’ content type, we have a Modular Group field named ‘Additional Info’ ("uid":"additional_info") that contains the Deals ("uid":"deals") and Rating ("uid":"rating") blocks. And, within the Deals and Rating blocks, we have the Deal Name ("uid":"deal_name") and Stars ("uid":"stars") fields, respectively. If, for instance, you want to retrieve the entries where either the value for Deal Name is ‘Christmas Deal’ or the value for Stars is '2', respectively, use the following value in the query parameter:

{"$or":[{"additional_info.deals.deal_name": "Christmas Deal"},{"additional_info.rating.stars": 2}]}

Get entries in which the value of a field is lesser than the value provided in the condition.

This query will work for both entries as well as assets.

Example: Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is less than but not equal to 600. You can send the parameter as:

{ "price_in_usd": { "$lt": 600 } }

This will give you all the entries of mobile phones costing less than but not equal to $600.

Let’s consider another example. You want to retrieve all the entries that have their start date before 8th December, 2017. Now, you need to set this parameter with the date in the ISO Date format as below:

{ "start_date": { "$lt": "2017-12-08T00:00:00.000Z" } }

This will give you all the entries where the start date is before 8th December, 2017, but you will not get the entries of the same date.

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Less Than Operator Within Group

Get entries in which the value of a field is lesser than the value provided in the condition.

This query is specifically for fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve the entries in which the values for the Discount in Percentage field is less than ‘25’, use the following value in the query parameter:

{ "bank_offers.discount_in_percentage": { "$lt": 25 } }

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Less Than Operator Within Modular Blocks

Get entries in which the value of a field is lesser than the value provided in the condition.

This query is specifically for fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Block field, we have a field named Stars ("uid":"stars"). If, for instance, you want to retrieve the entries in which the values for the Stars field is less than ‘3’, use the following value in the query parameter:

{ "additional_info.rating.stars": { "$lt": 3 } }

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Get entries in which the value of a field is lesser than or equal to the value provided in the condition.This query will work for both entries as well as assets.

Example: Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is less than or equal to 146. To achieve this, send the parameter as:

{ "price_in_usd": { "$lte": 146 } }

This will give you all the entries of mobile phones costing less than and equal to $146.

Let’s consider another example. If you want to retrieve all the entries that have their start date before and on 8th December, 2017. Now, you need to set this parameter with the date in the ISO Date format as below:

{ "start_date": { "$lte": "2017-11-08T00:00:00.000Z" } }

This will give you all the entries before 8th December, 2017, along with the entries of 8th December, 2017.

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Less Than Or Equal To Operator Within Group

Get entries in which the value of a field is lesser than or equal to the value provided in the condition.This query is specifically for fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve the entries in which the values for the Discount in Percentage field is less than or equal to ‘24’, use the following value in the query parameter:

{ "bank_offers.discount_in_percentage": { "$lte": 27 } }

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Less Than Or Equal To Operator Within Modular Blocks

Get entries in which the value of a field is lesser than or equal to the value provided in the condition.This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Rating block, we have a field named Stars ("uid":"stars"). If, for instance, you want to retrieve the entries in which the values for the Stars field is less than or equal to ‘3’, use the following value in the query parameter:

{ "additional_info.rating.stars": { "$lte": 3 } }

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Get entries in which the value for a field is greater than the value provided in the condition.This query will work for both entries as well as assets.

Example: Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is greater than but not equal to 146. You can send the parameter as:

{ "price_in_usd": { "$gt": 146 } }

This will give you all the entries of mobile phones costing greater than and not equal to $146.

Let’s consider another example. If you want to retrieve all the entries that have their start date later than 8th December, 2017. Now, you need to set this parameter with the date in the ISO Date format as below:

{ "start_date": { "$gt": "2017-11-08T00:00:00.000Z" } }

This will give you all the entries after 8th December, 2017.

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Greater Than Operator Within Group

Get entries in which the value for a field is greater than the value provided in the condition.This query is specifically for entries and works on fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve the entries in which the values for the Discount in Percentage field is greater than ‘20’, use the following value in the query parameter:

{ "bank_offers.discount_in_percentage": { "$gt": 20 } }

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Greater Than Operator Within Modular Blocks

Get entries in which the value for a field is greater than the value provided in the condition.This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Block field, we have a field named Stars ("uid":"stars"). If, for instance, you want to retrieve the entries in which the values for the Stars field is greater than ‘3’, use the following value in the query parameter:

{"additional_info.rating.stars": {"$gt": 3}}

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Get entries in which the value of a field is greater than or equal to the value provided in the condition.
This query will work for both entries as well as assets.

Example: Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is greater than or equal to 146. You can send the parameter as:

{ "price_in_usd": { "$gte": 146 } }

This will give you all the entries of mobile phones costing greater than and equal to $146.

Let’s consider another example. You want to retrieve all the entries that have their start date 8th December, 2017, and later. Now, you need to set this parameter with the date in the ISO Date format as below:

{ "start_date": { "$gte": "2017-11-08T00:00:00.000Z" } }

This will give you all the entries where the start date falls after 8th December, 2017, along with the entries of the same date.

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Greater Than Or Equal To Operator Within Group

Get entries in which the value of a field is greater than or equal to the value provided in the condition.This query is specifically for fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve the entries in which the values for the Discount in Percentage field is greater than or equal to ‘20’, use the following value in the query parameter:

{ "bank_offers.discount_in_percentage": { "$gte": 20 } }

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

Greater Than Or Equal To Operator Within Modular Blocks

Get entries in which the value of a field is greater than or equal to the value provided in the condition.
This query is specifically for fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Rating block, we have a field named Stars' ("uid":"stars"). If, for instance, you want to retrieve the entries in which the values for the Stars field is greater than or equal to ‘3’, use the following value in the query parameter:

{"additional_info.rating.stars": {"$gte": 3}

Note: Avoid using seconds and milliseconds in date/time queries. We recommend to round off to the nearest minute (at most 5 minutes).

The limit parameter will return a specific number of entries in the output. So for example, if the content type contains more than 100 entries and you wish to fetch only the first 2 entries, you need to specify '2' as value in this parameter.

This query will work for both entries as well as assets.

Example:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&limit=2

Note: By default, the limit for response details per request is 100.

The skip parameter will skip a specific number of entries in the output. So, for example, if the content type contains around 12 entries and you want to skip the first 2 entries to get only the last 10 in the response body, you need to specify ‘2’ here.This query will work for both entries as well as assets.

Example:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&skip=2

When fetching entries, you can sort them in the ascending order with respect to the value of a specific field in the response body.

This query will work for both entries as well as assets.

Example: In the Product content type, if you wish to sort the entries with respect to their prices, the parameter can be used as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&asc=price_in_usd

This will give you all the entries sorted in the ascending order with respect to the Price in USD field.

Note: In situations where identical or empty/null values are present in the field selected for sorting, the sorting process may not yield accurate results, potentially leading to duplicate results in the output. To avoid this, consider utilizing fields without duplicate values, or fields that are indexed (for e.g., updated_at), to effectively sort your data. Alternatively, if you must use the non-indexed fields for sorting, please contact our Support team for assistance in adding indexes to the field and ensuring the correct sorting of your data within the query results. Please note that a maximum of 5 fields can be indexed per Organization.

Order by asc Operator Within Group

Sort your fetched entries in the ascending order with respect to the value of a specific field in the response body.This query is specifically for entries and works on fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve entries in the ascending order with respect to the Discount in Percentage field, use the following URL:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&asc=bank_offers.discount_in_percentage

Order by asc Operator within Modular Blocks

When fetching entries, you can sort your fetched entries in the ascending order with respect to the values of any block within a Modular Block field.

This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Note: Currently, this query is not applicable for Reference fields within Modular Blocks.

Example: In the Products content type, we have a Modular Block field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Rating block, we have a field named Stars ("uid":"stars"). Use the following URL to retrieve entries in ascending order based on the values of the Stars field:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&asc=additional_info.rating.stars

When fetching entries, you can sort them in the descending order with respect to the value of a specific field in the response body.

This query will work for both entries as well as assets.

Example: In the Product content type, if you wish to sort the entries with respect to their prices, the parameter can be used as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&desc=price_in_usd

This will give you all the entries sorted in the descending order with respect to the Price in USD field.

Note: In situations where identical or empty/null values are present in the field selected for sorting, the sorting process may not yield accurate results, potentially leading to duplicate results in the output. To avoid this, consider utilizing fields without duplicate values, or fields that are indexed (for e.g., updated_at), to effectively sort your data. Alternatively, if you must use the non-indexed fields for sorting, please contact our Support team for assistance in adding indexes to the field and ensuring the correct sorting of your data within the query results. Please note that a maximum of 5 fields can be indexed per Organization.

Order by desc Operator Within Group

Sort your fetched entries in the descending order with respect to the value of a specific field in the response body.This query is specifically for entries and works on fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve entries in the descending order with respect to the values of the Discount in Percentage field, use the following URL:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&desc=bank_offers.discount_in_percentage

Order by desc Operator Within Modular Blocks

Sort your fetched entries in the descending order with respect to the value of a specific field in the response body.This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Note: Currently, this query is not applicable for Reference fields within Modular Blocks.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Rating block, we have a field named Stars ("uid":"stars"). If, for instance, you want to retrieve entries in the descending order with respect to the values of the Stars field, use the following URL:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&desc=additional_info.rating.stars

Get entries if value of the field, mentioned in the condition, exists.This query will work for entries only.

Example: In the Product content type, we have a field named Price in USD. Now, you want to retrieve all the entries in the content type in which the field exists. You can send the parameter as:

{ "price_in_usd": { "$exists": true } }.

Exists Operator Within Group

Get entries if value of the field, mentioned in the condition, exists.This query is specifically for entries and work on fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Card Type ("uid":"card_type"). If, for instance, you want to retrieve the entries in which the values for the Discount in Percentage field exists, use the following value in the query parameter:

{"bank_offers.discount_in_percentage": { "$exists": true }}

Exists Operator Within Modular Blocks

Get entries if value of the field, mentioned in the condition, exists.This query is specifically for entries and works on fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Deals ("uid":"deals") block. And, within this Block field, we have a field named Deal Name ("uid":"deal_name"). If, for instance, you want to retrieve the entries in which the values for the Stars field exists, use the following value in the query parameter:

{"additional_info.rating.stars": {"$exists": true }}

The only[][] parameter will include the data of only the specified fields for each entry and exclude the data of all other fields. There are two approaches to this parameter. Firstly, we have the only[BASE][] parameter, where 'BASE' is the default value and refers to the top-level fields of the schema. Secondly, we have the only[Reference_field_uid][] parameter, where you need to enter the UID of the reference field in place of "Reference_field_uid".This query will work for entries only.

Example: In the Product content type, if we need to retrieve the data of only the Price in USD parameter of all the entries, you can send the parameter as:

https://cdn.contentstack.io/v3/content_types/author/entries?environment=production&only[BASE][]=price_in_usd

Only Operator Within Group

Get entries in which the data of a specific field is included in the response JSON.This query is specifically for entries and works on fields that are part of the Group field.

Example: In the Products’ content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve only the values of the Discount in Percentage field of all the entries, you can send the parameters as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&only[BASE][]=bank_offers.discount_in_percentage

Only Operator Within Modular Blocks

Get entries in which the data of a specific field is included in the response JSON.This query is specifically for fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Rating block, we have a field named Stars ("uid":"stars"). If, for instance, you want to retrieve the values of all the Stars field from all the entries, you can send the parameters as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&only[BASE][]=additional_info.rating.stars

The except[][] parameter will exclude the data of the specified fields for each entry and will include the data of the rest of the fields. There are two approaches to this parameter. Firstly, we have the except[BASE][] parameter, where 'BASE' is the default value and refers to the top-level fields of the schema. Secondly, we have the except[Reference_field_uid][] parameter, where you need to enter the UID of the reference field in place of Reference_field_uid.This query will work for entries only.

Example: In the Product content type, if we need to retrieve the data of entries of all the other fields except the Price in USD parameter, you can send the parameter as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&except[BASE][]=price_in_usd

Exclude Operator Within Group

Get entries in which the data of a specific field is excluded from the response JSON, but the data of the rest of the fields are included.This query is specifically for entries and works with fields that are part of the Group field.

Example: In the Products content type, we have a Group field named Bank Offers ("uid":"bank_offers"). And, within this Group field, we have a subfield named Discount in Percentage ("uid":"discount_in_percentage"). If, for instance, you want to retrieve all the entries of a content type, but exclude the data for the Discount in Percentage field in the JSON response, you can send the parameters as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&except[BASE][]=bank_offers.discount_in_percentage

Exclude Operator Within Modular Blocks

Get entries in which the data of a specific field is excluded from the response JSON, but the data of the rest of the fields are included.This query is specifically for entries and works with fields that are part of any block within a Modular Block field.

Example: In the Products content type, we have a Modular Group field named Additional Info ("uid":"additional_info") that contains the Rating ("uid":"rating") block. And, within this Block field, we have a field named Stars ("uid":"stars"). If, for instance, you want to retrieve all the entries of a content type, but exclude the data for the Stars field in the JSON response, you can send the parameters as:

https://cdn.contentstack.io/v3/content_types/product/entries?environment=production&except[BASE][]=additional_info.rating.stars

To retrieve the count of entries, we have two parameters: include_count (retrieves entries' details and their count) and count (retrieves only the count of entries).This query will work for both entries as well as assets.

Example: If you wish to know the total number of entries in the Product content type and also retrieve all the data, you need to run the following API request:

https://cdn.contentstack.io/v3/content_types/product/entries?environment={environment}&include_count=true

To get only the count, run the following API request:

https://cdn.contentstack.io/v3/content_types/product/entries?environment={environment}&count=true

The 'Get all entries' API request returns only the first 100 entries of the specified content type. Similarly, the 'Get all assets' request fetches the first 100 assets of a particular stack.

In both requests, first, use the include_count parameter to get the total count of the items (entries/assets). Learn more about the Count parameter.

Since only 100 items are returned at a time in your response (in case of both requests), you can get the rest of the items in batches using the skip parameter in subsequent requests. Learn more about the Skip parameter.

You can paginate the output of a request by using the limit parameter. For example, if you have 200 entries and/or assets and you want to retrieve them all but display only 10 items at a time. Use the limit=10 and skip=10 parameters, to get them all but display only 10 items per page.

The syntax of the pagination request will look like the following:

• For entries: https://cdn.contentstack.io/v3/content_types/product/entries?environment={environment}&locale={locale}&include_count=true&skip={skip_value}&limit={limit_value}
• For assets: https://cdn.contentstack.io/v3/assets?environment={environment_name}&include_dimension={boolean_value}&include_count=true&skip={skip_value}&limit={limit_value}