Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt

Use this file to discover all available pages before exploring further.

​
list()

Returns a paginated list of relations for a project.

​
Signature

royaltyport.relations.list(projectId, options?)

​
Parameters

ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID
options.pagenumberNo1Page number
options.perPagenumberNo20Items per page (max: 100)
options.includeMergedbooleanNofalseInclude merged relation records

​
Example

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

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

const { data } = await royaltyport.relations.list('project-id', {
  perPage: 100,
  includeMerged: true,
});

for (const relation of data.items) {
  console.log(`${relation.name} — ${relation.email ?? 'no email'}`);
}

​
get()

Returns a single relation by ID.

​
Signature

royaltyport.relations.get(projectId, relationId, options?)

​
Parameters

ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID
relationIdnumberYes—The relation ID
options.includeMergedbooleanNofalseInclude merged relation records

​
Example

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

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

const { data: relation } = await royaltyport.relations.get('project-id', 8);

console.log(relation.name);
console.log('Phone:', relation.phone);
The merged array only appears when includeMerged is set to true.