Endpoints for catalog administration (Admin only)
Block/unblock content globally
Blocks or unblocks content (songs or collections) GLOBALLY. When blocked=true, a BlockReason is REQUIRED and an optional comment can be provided. The content will have state BLOCKED_ADMIN for ALL regions. When blocked=false, the content is unblocked globally (reason and comment are ignored). This does NOT modify the regional blacklist. Use /availability endpoint to manage regional blocks. All block/unblock actions (with reason and comment) are logged in the audit trail and stored in content_blocks table.
path Parameters
contentIdUnique identifier of the content
query Parameters
contentTypeType of content (SONG or COLLECTION)
Block/unblock content globally › Request Body
blockedWhether to block the content globally. True = BLOCKED_ADMIN for all regions, False = unblock
reasonReason code for blocking the content. Required when blocked=true
commentAdditional comment explaining the block. Optional but recommended
Block/unblock content globally › Responses
Block status updated successfully
Get availability details
Returns detailed availability information including regional settings, block status, scheduling, and state per region. For songs, shows inherited availability from their collection.
path Parameters
contentIdUnique identifier of the content
query Parameters
contentTypeType of content (SONG or COLLECTION)
Get availability details › Responses
Availability details retrieved successfully
effectiveStateEffective state
blockedByAdminBlocked by admin
blockedRegionsBlocked regions
releaseDateRelease date
Regional state information
Update regional availability blacklist (PUT)
Replaces the entire regional blacklist for content with the provided list. This is a PUT operation - the complete blacklist must be provided. Regions in the blacklist will have state NOT_AVAILABLE_REGION. Empty set or null = no regional restrictions (available in all regions). GLB (Global) can be included in the blacklist to mark content as not available in the global region. Note: This is different from the /block endpoint which sets BLOCKED_ADMIN state. Regional blacklist (NOT_AVAILABLE_REGION) vs Global block (BLOCKED_ADMIN) are different states. Changes are logged in the audit trail.
path Parameters
contentIdUnique identifier of the content
query Parameters
contentTypeType of content (SONG or COLLECTION)
Update regional availability blacklist (PUT) › Request Body
blockedRegionsComplete list of regions to block (blacklist). This replaces any existing blacklist. Empty set = no regional restrictions. GLB can be included to mark as not available in global region.
Update regional availability blacklist (PUT) › Responses
Regional blacklist updated successfully
Get all content
Returns a paginated and filtered list of all catalog content (songs and collections). Supports search, filtering by content type, effective state, release date range, video availability, and region.
query Parameters
pagePage number (0-based)
sizeNumber of items per page
searchSearch term for title or artist name. Empty or null = get all.
contentTypeFilter by content type (SONG, ALBUM, EP, SINGLE, PLAYLIST)
effectiveStateFilter by effective state (PUBLISHED, SCHEDULED, BLOCKED_ADMIN, NOT_AVAILABLE_REGION)
hasVideoFilter songs by video availability
releaseDateFromFilter by release date from (ISO-8601 format)
releaseDateToFilter by release date to (ISO-8601 format)
regionRegion to check availability. Values: GLB (Global), NAM (North America), CAM (Central America), SAM (South America), EUW (Western Europe), EUE (Eastern Europe), EUN (Northern Europe), AFR (Africa), ASW (Western Asia), ASE (Eastern Asia), ASS (Southern Asia), ASC (Central Asia), OCE (Oceania). If not specified, returns content from all regions without regional filtering.
User Region
Get all content › Responses
Content retrieved successfully
totalElementstotalPagesnumberOfElementssizenumberfirstlastemptyGet audit trail
Returns the paginated audit trail showing administrative changes made to the content. Tracks block/unblock events and regional availability changes with timestamps and admin details for both songs and collections.
path Parameters
contentIdUnique identifier of the content
query Parameters
contentTypeType of content (SONG or COLLECTION)
pagePage number (0-based)
sizeNumber of items per page
Get audit trail › Responses
Audit trail retrieved successfully
List of audit events for current page
pageCurrent page number (0-based)
sizeNumber of items per page
totalElementsTotal number of audit events
totalPagesTotal number of pages
firstWhether this is the first page
lastWhether this is the last page
Get song details
Returns comprehensive information about a specific song including metadata, collection, scheduling, and availability status.
path Parameters
songIdUnique identifier of the song
Get song details › Responses
Song details retrieved successfully
idSong ID
titleSong title
durationSecondsDuration in seconds
primaryArtistNamePrimary artist name
primaryArtistIdPrimary artist ID
collaboratorIdsCollaborator IDs
collectionTitleCollection title (album/single)
collectionIdCollection ID
collectionTypeCollection type (ALBUM, SINGLE, EP)
positionInCollectionPosition in collection
releaseDateRelease date
scheduledAtScheduled release date
videoUrlVideo URL
explicitExplicit content
coverUrlCover URL
storageReferenceStorage reference (audio file)
genresGenres
moodsMoods
blockedByAdminBlocked by admin
effectiveStateEffective state
likesCountLikes count
deletedDeleted flag
createdAtCreation timestamp
updatedAtLast update timestamp
Get collection details
Returns comprehensive information about a specific collection including metadata, songs, scheduling, and availability settings.
path Parameters
collectionIdUnique identifier of the collection
Get collection details › Responses
Collection details retrieved successfully
idCollection ID
titleCollection title
descriptionDescription
coverUrlCover URL
typeCollection type (ALBUM, SINGLE, EP)
primaryArtistIdPrimary artist ID
scheduledReleaseDateScheduled release date
actualReleaseDateActual release date
blockedByAdminBlocked by admin
blockedRegionsBlocked regions
availableRegionsAvailable regions
effectiveStateEffective state
Songs in collection
createdAtCreation timestamp
updatedAtLast update timestamp