Entry Variants

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.

NoteBy 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

TipThis 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.

NoteBy 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

TipThis 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}}
      }
    }
  ]
}