Skip to main content

Overview

API tokens allow you to authenticate programmatically with the Royaltyport API. Each token is scoped to either your entire organization or a specific project, and can have a configurable expiration date. Only organization Admins and Owners can create and delete tokens.
The Royaltyport API is currently in closed Beta. Contact hello@royaltyport.com to get early access.

Accessing API Tokens

1

Go to Organization Settings

Navigate to your organization from the Dashboard, then click Settings in the navigation.
2

Select Tokens

Click the Tokens tab in the settings sidebar.

Creating a Token

1

Enter a token name

Give the token a unique, descriptive name so you can identify it later (e.g., “Production Integration” or “Data Export Script”).
2

Select a scope

Choose what this token should have access to:
ScopeAccess
OrganizationGrants access to all projects within your organization
Specific projectRestricts access to a single named project only
Use a project-scoped token when you want to limit a token’s access to one project (e.g., for a third-party integration). Use an organization-scoped token when your workflow spans multiple projects.
3

Set an expiration

Choose how long the token should remain valid:
OptionDuration
1 DayExpires after 1 day
7 DaysExpires after 7 days
30 DaysExpires after 30 days
60 DaysExpires after 60 days
90 DaysExpires after 90 days
NeverToken does not expire
A preview of the exact expiration date is shown below the selector.
4

Click Create

Click the Create button. A dialog will appear showing your new token value.
5

Copy and save your token

Copy the token and store it in a secure location such as a password manager or secrets vault.
This is the only time your token value will be displayed. Once you close the dialog, it cannot be retrieved again.

Managing Existing Tokens

The tokens table shows all active tokens for your organization, including:
ColumnDescription
NameThe token’s display name
CreatedWhen the token was created and when it expires
ScopeEither Organization (access to all projects) or the name of a specific project
Last activeWhen the token was last used to make an API request

Deleting a Token

To delete a single token, click the menu on any row and select Delete. Confirm in the dialog that appears.
Deleting a token is immediate and cannot be undone. Any application or script using that token will lose access right away.

Bulk deletion

To delete multiple tokens at once, select the checkboxes next to the tokens you want to remove, then open the menu in the table header and choose Delete selected.

Permission Requirements

ActionRequired Role
View tokensAdmin, Owner
Create a tokenAdmin, Owner
Delete a tokenAdmin, Owner
Members with the Member role cannot access organization settings and cannot manage API tokens.

API Introduction

Learn how to authenticate and use the Royaltyport API.

Members & Roles

Understand organization role permissions.

General Settings

Configure your organization’s basic information.

Security

Configure SSO and audit logs.