Skip to main content

list()

Returns all projects accessible to the authenticated token.

Signature

royaltyport.projects.list()

Example

import { Royaltyport } from '@royaltyport/sdk';

const royaltyport = new Royaltyport({
  apiKey: 'rp_your_token_here',
});

const { data: projects } = await royaltyport.projects.list();

for (const project of projects) {
  console.log(`${project.name} (${project.id})`);
}
A project-scoped token returns only its assigned project. An organization-scoped token returns all projects.

get()

Returns a single project by ID.

Signature

royaltyport.projects.get(projectId)

Parameters

ParameterTypeRequiredDescription
projectIdstringYesThe project ID

Example

import { Royaltyport } from '@royaltyport/sdk';

const royaltyport = new Royaltyport({
  apiKey: 'rp_your_token_here',
});

const { data: project } = await royaltyport.projects.get('a1b2c3d4-e5f6-7890-abcd-ef1234567890');

console.log(project.name);       // "Record Label Ltd"
console.log(project.created_at); // "2025-01-15T12:00:00Z"