Skip to main content
GET
/
checklist
/
enrichment
List Enrichment Items
curl --request GET \
  --url https://api.royalti.io/checklist/enrichment \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/checklist/enrichment"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/checklist/enrichment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/checklist/enrichment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/checklist/enrichment"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.royalti.io/checklist/enrichment")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/checklist/enrichment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "TenantId": 123,
      "batchId": "<string>",
      "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isrc": "<string>",
      "upc": "<string>",
      "rawTitle": "<string>",
      "rawArtist": "<string>",
      "rawLabel": "<string>",
      "rawAggregator": "<string>",
      "rawTracklist": "<string>",
      "rawMetadata": {},
      "enrichedTitle": "<string>",
      "enrichedArtist": "<string>",
      "enrichedGenre": [
        "<string>"
      ],
      "enrichedDuration": 123,
      "enrichedReleaseDate": "<string>",
      "enrichedLabel": "<string>",
      "enrichedAlbumArt": "<string>",
      "enrichmentConfidence": 0.5,
      "artists": {
        "Burna Boy": "primary",
        "Wizkid": "featuring"
      },
      "finalData": {},
      "createdItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "importError": "<string>",
      "reviewedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reviewedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "size": 123,
    "totalPages": 123
  }
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

/checklist/enrichment Retrieves a list of staged enrichment items. Supports filtering by type, status, and batch ID. Results are paginated by default (max 200 per page). Use all=true to fetch all matching records without pagination. Authorization:
  • Required role: admin or higher
Method: GET

Code Examples

const response = await fetch('https://api.royalti.io/checklist/enrichment', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
  'https://api.royalti.io/checklist/enrichment',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/checklist/enrichment \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

type
enum<string>

Filter by entity type

Available options:
asset,
product
status
enum<string>

Filter by status

Available options:
pending,
approved,
rejected,
imported,
failed
batchId
string

Filter by batch ID

all
enum<string>

Set to true to return all matching records without pagination

Available options:
true
page
integer
default:1

Page number (ignored when all=true)

size
integer
default:50

Items per page (ignored when all=true)

Required range: x <= 200

Response

Successfully retrieved enrichment items

status
string
Example:

"success"

data
object[]
pagination
object