---
title: "Retrieve renditions for a specified entity"
method: POST
path: "/api/entities/{entityId}/renditions"
tags: ["Entities"]
---

# Retrieve renditions for a specified entity

`POST /api/entities/{entityId}/renditions`

## Request

- Base URL: `https://your-server`
- URL: `https://your-server/api/entities/{entityId}/renditions`
- Auth: OAuth 2
  - Authorization code: `/oauth/authorize`
  - Token URL: `/oauth/token`
- TypeScript: <https://skmtc.dev/sitecore/apis/entities-api/docs/api/entities/:entityId/renditions/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves information about renditions that exist for a specified entity, including their gateway links and delivery links. Renditions can be filtered by `area of use` or by their `rendition link name`, or both.

## Path parameters

- `entityId` integer, required

## Request body

- RenditionFilterResource: Filter when requesting existing renditions for an entity.
  - `rendition_link_names` string[], nullable: The names of the rendition links to return if they exist on the entity.
  - `areas_of_use` string[], nullable: The area of use of the rendition links to return. For example, the area of use `Download` will return all existing renditions that are available for the download component. See the `RenditionLinkIntendedAreaOfUse` option list for all available values.

## Response `200`

Successful operation

- RenditionsAggregateResource: Represents a collection of renditions metadata.
  - `entity_id` integer: The unique identifier for the targeted entity.
  - `renditions` RenditionsResource[], nullable: Collection of renditions metadata.
    - `rendition_link` RenditionLinkInfo: Metadata about a rendition link.
      - `id` integer: Unique identifier for the rendition link.
      - `name` string, nullable: Name of the rendition link.
      - `description` string, nullable: A description for the rendition link.
      - `is_user_rendition` boolean, nullable: Whether the rendition link is for a user rendition.
      - `required_permissions` string[], nullable: List of the permission required to access the rendition link.
      - `processing_configuration` object, nullable: The processing configuration in case of user renditions to be able to generate the rendition.
      - `labels` object, nullable: The labels in all languages for the rendition link.
      - `watermarking` WatermarkInfo: Metadata about when watermarking can potentially be applied on a rendition.
        - `gateway_enabled` boolean: Whether the watermarking can appear on gateway links for this rendition.
        - `delivery_enabled` boolean: Whether the watermarking can appear on delivery links for this rendition.
      - `areas_of_use` string[], nullable: The area of use of the rendition link.
    - `file_location` FileLocation: Information about the rendition's files.
      - `location` string, nullable: The files storage location name.
      - `files` FileInfo[], nullable: Collection of Information about the files.
        - `file_key` string, nullable: The key identifying the file.
        - `metadata` object, nullable: Metadata about the file.
        - `delivery_link` Link: Represents a link to a resource.
          - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to.
          - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to.
          - `title` string, nullable: Gets or sets the title that describes this link.
          - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template.
    - `rendition_status` string, nullable: Status of the rendition.
    - `gateway_link` Link: Represents a link to a resource.
      - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to.
      - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to.
      - `title` string, nullable: Gets or sets the title that describes this link.
      - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template.
    - `created_by` integer, nullable: The user who created the rendition.
    - `modified_by` integer, nullable: The user who last modified the rendition.
    - `self` Link: Represents a link to a resource.
      - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to.
      - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to.
      - `title` string, nullable: Gets or sets the title that describes this link.
      - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template.
  - `self` Link: Represents a link to a resource.
    - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to.
    - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to.
    - `title` string, nullable: Gets or sets the title that describes this link.
    - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template.

## Other responses

- `400`: Request not valid, such as invalid entity ID or missing filter
- `401`: Unauthorized request
- `404`: Entity not found or user not authorized to access the renditions

---

[API](https://skmtc.dev/sitecore/apis/entities-api.md) - [All operations](https://skmtc.dev/sitecore/apis/entities-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sitecore/apis/entities-api/revisions/328bbdd51028?raw)