List Recordings
Returns a paginated list of recordings for a project. Recordings represent sound recordings extracted from contract documents.
Request
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|
projectId | UUID | Yes | — | The project to list recordings for |
page | integer | No | 1 | Page number (1-indexed) |
perPage | integer | No | 20 | Items per page (1–100) |
includeProducts | string | No | false | Set to true to include associated products for each recording |
| Header | Required | Description |
|---|
Authorization | Yes | Bearer <token> — must be scoped to the requested project |
Response
{
"data": {
"items": [
{
"id": "rec-1",
"name": "Rolling in the Deep",
"duration_ms": 228000,
"type": "single",
"artists": ["Adele"],
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-06-01T12:00:00Z",
"products": [
{
"name": "21",
"upc": "123456789012",
"release_date": "2011-01-24",
"artists": ["Adele"],
"source": "spotify",
"store": "Spotify"
}
]
}
],
"total_count": 87,
"page": 1,
"per_page": 20
}
}
The products array only appears when includeProducts=true.
Errors
| Status | Description |
|---|
400 | Missing projectId or invalid query parameters |
403 | Token is not scoped to the requested project |
Example
curl "https://api.royaltyport.com/v1/recordings?projectId=a1b2c3d4-...&page=1&perPage=50" \
-H "Authorization: Bearer rp_your_token_here"
Get Recording
Returns a single recording by ID.
Request
GET /v1/recordings/{recording_id}
Path Parameters
| Parameter | Type | Required | Description |
|---|
recording_id | string | Yes | The recording ID |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|
projectId | UUID | Yes | — | The project the recording belongs to |
includeProducts | string | No | false | Set to true to include associated products |
| Header | Required | Description |
|---|
Authorization | Yes | Bearer <token> — must be scoped to the requested project |
Response
{
"data": {
"id": "rec-1",
"name": "Rolling in the Deep",
"duration_ms": 228000,
"type": "single",
"artists": ["Adele"],
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-06-01T12:00:00Z",
"products": [
{
"name": "21",
"upc": "123456789012",
"release_date": "2011-01-24",
"artists": ["Adele"],
"source": "spotify",
"store": "Spotify"
}
]
}
}
Errors
| Status | Description |
|---|
400 | Missing projectId |
403 | Token is not scoped to the requested project |
404 | Recording not found |
Example
curl "https://api.royaltyport.com/v1/recordings/rec-1?projectId=a1b2c3d4-..." \
-H "Authorization: Bearer rp_your_token_here"
