Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
custom renditions

Retrieve list of custom text renditions

Retrieves a list of custom text renditions

get/v2/sites/{site_id}/media/{media_id}/custom_text_renditions/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

media_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the media

Query parameters

pageinteger

Sets the page number for pagination. First page is 1.

page_lengthinteger

Sets the page length (number of items you get in the response) for pagination

If page_length is not specified, the default value will be set.

Default: 10

sortstring

Allows for sorting results

Example: sort=priority:asc

Sort order can be asc or dsc. Additionally, custom text renditions can be sorted by the following attributes:

  • priority
  • size

Response

Custom Text Rendition Resources

pageinteger

Offset for returned resources

page_lengthinteger

Maximum number of resources to return

totalinteger

Number of resources available before pagination

Example response

{
  "page": 1,
  "page_length": 10,
  "total": 1,
  "text_renditions": [
    {
      "id": "aBcD1234",
      "created": "2018-10-02T21:19:36.602019+00:00",
      "last_modified": "2018-10-02T21:19:36.602019+00:00"
    }
  ]
}