Album by slug

Endpoint Overview

Endpoint Name: Album by slug
Purpose: Retrieves the detail of an album by its slug for a specific culture.
Method: GET
URL: /{version}/content/{culture}/albums/{slug}

Authentication

Authentication Type: None

Request

Headers

Header Name	Required	Description
accept	Yes	`application/json`

Path Parameters

Parameter	Type	Description
version	string	The version of the API to be used. Allowed values: `v2`.
culture	string	The culture's identifier. E.g., `en-us`.
slug	string	The language-specific identifier of the album.

Query Parameters

None.

Response

Response Codes

HTTP Status Code	Meaning
200	Successful request
404	Not Found (resource does not exist)
500	Internal Server Error

Response Body

Data structure

type: album (String)
_entityId: The language-independent unique identifier of the entity (Entity Code) (Guid)
_translationId: The language-specific unique identifier of the entity (Localized Entity Code) (Guid)
selfUrl: The URL to get the detail of this entity (String)
slug: The unique identifier of the album (String)
title: The album title (String)
description: The album description (String)
contentDate: The UTC timestamp of this content (Date-time)
createdBy: The full name of the author that created this entity (String)
lastUpdatedBy: The full name of the last author that updated this entity (String)
lastUpdatedDate: UTC timestamp of the last update operation occurred on this entity (Date-time)
featured: When 1, it represents a promoted content (Integer)
thumbnail: An object representing the thumbnail of the picture bound to the current album (Object)
- title: The title of the photo (String)
- templateUrl: The template URL that can be used to retrieve the photo file from Cloudinary (String). Contains {formatName} or {formatInstructions} placeholders. (String)
- thumbnailUrl: The URL of the thumbnail format that can be used to retrieve the photo from Cloudinary (String)
- format: The format of the original image (e.g., jpg, png, etc.) (String)
- overriddenFormats: An object representing details related to the custom cropping coordinates set for this photo, if present. Available only when the system is configured with the cropping option (Object)
- slug: The language-specific unique identifier of the photo entity used as the thumbnail (String)
- selfUrl: The URL to get the detail of this entity (String)
tags: An array of objects containing the set of tags related to this album (Array)
- type: tag (String)
- selfUrl: The URL to get the detail of the tag entity (String)
- slug: The language-specific unique identifier of the tag bound to the album (String)
- neutralSlug: The language-independent unique identifier of the tag bound to the album (String)
- externalSourceName: The name of the external source from where the tag was selected. If null, the tag is of type free-text (String)
- title: The title of the tag in the current language (String)
- extraData: An object containing custom-defined data, bound to the current tag (Object)
- fields: An object representing the available custom fields for the tag (Object)
elements: An array of objects containing the set of items composing this album (Array)
- type: The type of content represented by this part. (Possible values: photo) (String)
- _entityId: The language-independent unique identifier of the entity (Entity Code) (Guid)
- _translationId: The language-specific unique identifier of the entity (Localized Entity Code) (Guid)
- selfUrl: The URL to get the detail of this photo entity (String)
- title: Title of the photo (String)
- slug: The unique identifier of the photo (String)
- fields: An object representing the available custom fields for this photo (Object)
- image: An object representing the information related to the image represented by this item (Object)
  - title: The title of the photo (String)
  - templateUrl: The template URL that can be used to retrieve the photo file from Cloudinary (String). Contains {formatName} or {formatInstructions} placeholders. (String)
  - thumbnailUrl: The URL of the thumbnail format that can be used to retrieve the photo from Cloudinary (String)
  - format: The format of the original image (e.g., jpg, png, etc.) (String)
  - overriddenFormats: An object representing details related to the custom cropping coordinates set for this photo, if present. Available only when the system is configured with the cropping option (Object)
relations: An array of objects containing the set of relations added to this album (Array)

ℹ️ From version 16.5.0, the related stories contain the field Headline.
references: An object containing the set of reference fields defined on this entity (Object)
context: An object containing the information related to the tag used as the context (same contract as tag) (Object)
fields: An object representing the available custom fields for this album (Object)
_listAvailability: An integer with two possible values: 0 and 1.
- When 0, it represents that the content is available in the list.
- When 1, it represents unlisted content. (Integer)

Successful Response Example

Request GET https://acme.org/v2/content/en-us/albums/rowing-album

Response

▼ "root": {
"type": "album"
"_translationId": "d30f92af-56f0-4f2d-a1b4-3c521425cf9b"
"_entityId": "b05ce183-6bcc-44f4-bf1c-c057ca28903c"
"selfUrl": "https://acme.org/v2/content/en-us/albums/rowing-album"
"slug": "rowing-album"
"title": "Rowing album"
▼ "tags": [
▼ "0": {
"_translationId": "a6f13b8a-cd67-4e9f-82c8-798d47d1c389"
"_entityId": "7458c096-8d65-40a3-b535-f8ba1a08ccfa"
"selfUrl": "https://acme.org/v2/content/en-us/tags/rowing"
"title": "rowing"
"slug": "rowing"
"neutralSlug": "rowing"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
]
▼ "relations": [
▼ "0": {
"type": "story"
"_translationId": "24904094-67ae-4c04-8ea6-51060a08e6a1"
"_entityId": "1fdd46a6-2e9b-4d9f-8557-88b6bed902f8"
"selfUrl": "https://acme.org/v2/content/en-us/stories/a-handful-of-olympic-and-paralympic-rowing-facts"
"title": "A handful of Olympic and Paralympic rowing facts"
"slug": "a-handful-of-olympic-and-paralympic-rowing-facts"
▼ "fields": {
}
"summary": "The familiar story goes that rowing was included at the first Olympic Games in 1896, but due to inclement weather, the rowing races were cancelled. There were only a handful of countries set to participate, among them France, Germany, Italy and Greece, in just four boat classes. While rowing today"
▼ "thumbnail": {
"title": "2019-05-29-redgrave-pintest-featured"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/zaxax7s7k6z2lgoyb59x"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/zaxax7s7k6z2lgoyb59x"
"format": "jpg"
▼ "overriddenFormats": {
}
"slug": "2019-05-29-redgrave-pintest-featured"
"selfUrl": "https://acme.org/v2/content/en-us/photos/2019-05-29-redgrave-pintest-featured"
}
"featured": 0
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-07-28T14:41:30.491Z"
"contentDate": "2020-07-21T07:34:19.442Z"
▼ "tags": [
▼ "0": {
"_translationId": "a6f13b8a-cd67-4e9f-82c8-798d47d1c389"
"_entityId": "7458c096-8d65-40a3-b535-f8ba1a08ccfa"
"selfUrl": "https://acme.org/v2/content/en-us/tags/rowing"
"title": "rowing"
"slug": "rowing"
"neutralSlug": "rowing"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
]
}
]
▼ "references": {
}
▼ "fields": {
}
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-07-28T14:41:34.908Z"
"contentDate": "2020-05-28T16:47:54.215Z"
"featured": 0
▼ "thumbnail": {
"title": "1 - SN086zQ"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/yyd4ehfswo7p878drhu4"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/yyd4ehfswo7p878drhu4"
"format": "jpg"
▼ "overriddenFormats": {
}
"slug": "1-sn086zq"
"selfUrl": "https://acme.org/v2/content/en-us/photos/1-sn086zq"
}
"description": ""
▼ "elements": [
▼ "0": {
"type": "photo"
"_translationId": "3a118bfb-9f31-4df0-8084-d49f40e195d3"
"_entityId": "3ec2aeac-4729-426e-bc3d-bb9d4b9808ae"
"selfUrl": "https://acme.org/v2/content/en-us/photos/1-sn086zq"
"title": "1 - SN086zQ"
"slug": "1-sn086zq"
▼ "fields": {
}
▼ "image": {
"title": "1 - SN086zQ"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/yyd4ehfswo7p878drhu4"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/yyd4ehfswo7p878drhu4"
"format": "jpg"
▼ "overriddenFormats": {
}
}
"featured": 0
▼ "tags": [
]
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-07-22T08:58:44.232Z"
"contentDate": "2020-02-18T08:55:48.691Z"
}
▼ "1": {
"type": "photo"
"_translationId": "e69fdc4e-c4ea-415b-aeb3-d1927dfa2bef"
"_entityId": "811f692a-2d5f-418c-b0d7-9b2e907c8d38"
"selfUrl": "https://acme.org/v2/content/en-us/photos/2019-05-29-redgrave-pintest-featured"
"title": "2019-05-29-redgrave-pintest-featured"
"slug": "2019-05-29-redgrave-pintest-featured"
▼ "fields": {
}
▼ "image": {
"title": "2019-05-29-redgrave-pintest-featured"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/zaxax7s7k6z2lgoyb59x"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/zaxax7s7k6z2lgoyb59x"
"format": "jpg"
▼ "overriddenFormats": {
}
}
"featured": 0
▼ "tags": [
]
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-07-21T07:33:43.554Z"
"contentDate": "2020-07-21T07:33:43.554Z"
}
▼ "2": {
"type": "photo"
"_translationId": "7800fad8-7bb9-4cef-98cb-8897bb1fa7cd"
"_entityId": "074ef838-1fda-4631-ba3f-3718133e69c3"
"selfUrl": "https://acme.org/v2/content/en-us/photos/9-rhj76el"
"title": "9 - Rhj76el"
"slug": "9-rhj76el"
▼ "fields": {
}
▼ "image": {
"title": "9 - Rhj76el"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/lsrvta9vmqtcoaeretue"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/lsrvta9vmqtcoaeretue"
"format": "jpg"
▼ "overriddenFormats": {
}
}
"featured": 0
▼ "tags": [
]
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-07-28T14:41:33.161Z"
"contentDate": "2020-02-18T08:56:28.35Z"
}
]
}

Error Response Example

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-136f600b8c8d7ff6adc6c91ad120030a-40a7c87bf5ee8fdf-00"
}

Common Errors and Troubleshooting

List common pitfalls and errors users may encounter
Provide clear guidance on how to resolve these issues

Provide links or references to related API endpoints for easy navigation

Endpoint Overview​

Authentication​

Request​

Headers​

Path Parameters​

Query Parameters​

Response​

Response Codes​

Response Body​

Data structure​

Successful Response Example​

Error Response Example​

Common Errors and Troubleshooting​

Related Endpoints​

Endpoint Overview

Authentication

Request

Headers

Path Parameters

Query Parameters

Response

Response Codes

Response Body

Data structure

Successful Response Example

Error Response Example

Common Errors and Troubleshooting

Related Endpoints