list()
Returns a paginated list of relations for a project.
Signature
royaltyport.relations.list(projectId, options?)
Parameters
| Parameter | Type | Required | Default | Description |
|---|
projectId | string | Yes | — | The project ID |
options.page | number | No | 1 | Page number |
options.perPage | number | No | 20 | Items per page (max: 100) |
options.includeMerged | boolean | No | false | Include 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
| Parameter | Type | Required | Default | Description |
|---|
projectId | string | Yes | — | The project ID |
relationId | number | Yes | — | The relation ID |
options.includeMerged | boolean | No | false | Include 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.
