API reference

Overview

Every endpoint of the API, by what it works on.

On this page

Account
Reference
Labels
Artists
Releases
Tracks
Splits
Files
Distribution
Events
Webhooks
Money
Smart links
Cover licences
Sandbox

Every endpoint, by what it works on, after the base address https://api.stillmoregroup.com/api/v1. The errors page has every error code.

Account#

Who a call acts for, and the organizations a key can act for. All of Account.

Endpoint	What it does	Scope
`GET /me`	Who the key is	Any key
`GET /organizations`	Organizations the key can act for	Any key

Reference#

The values other endpoints accept: genres, languages, stores, territories and roles. All of Reference.

Endpoint	What it does	Scope
`GET /reference`	Genres, languages, countries and stores	Any key

Labels#

The labels releases come out under. All of Labels.

Endpoint	What it does	Scope
`GET /labels`	List labels	`labels:read`
`POST /labels`	Create a label or imprint	`labels:write`
`GET /labels/{labelId}`	Read a label	`labels:read`
`PATCH /labels/{labelId}`	Change a label	`labels:write`

Artists#

Artists, songwriters and composers, and their store profiles. All of Artists.

Endpoint	What it does	Scope
`GET /artists`	List artists	`artists:read`
`POST /artists`	Add an artist to the roster	`artists:write`
`GET /artists/{artistId}`	Read an artist	`artists:read`
`PATCH /artists/{artistId}`	Change an artist	`artists:write`

Releases#

Releases: drafts with their tracks, one at a time or many. All of Releases.

Endpoint	What it does	Scope
`GET /releases`	List releases	`releases:read`
`POST /releases`	Create a draft release	`releases:write`
`GET /releases/{releaseId}`	Read a release with its tracks	`releases:read`
`PATCH /releases/{releaseId}`	Change a draft release	`releases:write`
`DELETE /releases/{releaseId}`	Archive a draft release	`releases:write`
`POST /releases/batch`	Create many draft releases	`releases:write`

Tracks#

Tracks on a release, their order and their details. All of Tracks.

Endpoint	What it does	Scope
`GET /tracks`	Find tracks	`releases:read`
`GET /releases/{releaseId}/tracks`	A release's tracklist	`releases:read`
`POST /releases/{releaseId}/tracks`	Add a track	`releases:write`
`PUT /releases/{releaseId}/tracks/order`	Reorder the tracklist	`releases:write`
`GET /tracks/{trackId}`	Read a track	`releases:read`
`PATCH /tracks/{trackId}`	Change a track	`releases:write`
`DELETE /tracks/{trackId}`	Remove a track	`releases:write`

Splits#

How a release's or a track's money is shared between collaborators. All of Splits.

Endpoint	What it does	Scope
`GET /releases/{releaseId}/split`	The release-wide royalty split	`releases:read`
`PUT /releases/{releaseId}/split`	Set the release-wide royalty split	`releases:write`
`GET /tracks/{trackId}/split`	A track's own royalty split	`releases:read`
`PUT /tracks/{trackId}/split`	Set a track's own royalty split	`releases:write`

Files#

Covers and masters: signed uploads, imports from a link, and downloads. All of Files.

Endpoint	What it does	Scope
`POST /releases/{releaseId}/artwork`	Start a cover upload	`releases:write`
`POST /releases/{releaseId}/artwork/complete`	Finish a cover upload	`releases:write`
`POST /releases/{releaseId}/artwork/import`	Fetch a cover from a link	`releases:write`
`GET /releases/{releaseId}/artwork`	Download the cover	`releases:read`
`DELETE /releases/{releaseId}/artwork`	Remove the cover	`releases:write`
`POST /tracks/{trackId}/audio`	Start a master upload	`releases:write`
`POST /tracks/{trackId}/audio/complete`	Finish a master upload	`releases:write`
`POST /tracks/{trackId}/audio/import`	Fetch a master from a link	`releases:write`
`GET /tracks/{trackId}/audio`	Download the master	`releases:read`
`DELETE /tracks/{trackId}/audio`	Remove the master	`releases:write`
`GET /imports/{importId}`	Follow a file import	`releases:read`

Distribution#

Checks, sending releases to review and the stores, takedowns and rights documents. All of Distribution.

Endpoint	What it does	Scope
`GET /releases/{releaseId}/checks`	Check a release before sending it	`releases:read`
`POST /releases/{releaseId}/submit`	Send a release to distribution	`releases:submit`
`POST /releases/submit`	Send many releases to distribution	`releases:submit`
`POST /releases/{releaseId}/takedown`	Ask for a live release to come down	`releases:submit`
`POST /releases/{releaseId}/documents`	Start a document upload	`releases:write`
`POST /releases/{releaseId}/documents/complete`	Finish a document upload	`releases:write`

Events#

Every event of the last 30 days, the same ones webhooks deliver. All of Events.

Endpoint	What it does	Scope
`GET /events`	Read back events	Any key

Webhooks#

Endpoints that receive events, their deliveries and their secrets. All of Webhooks.

Endpoint	What it does	Scope
`GET /webhooks`	List webhook endpoints	`webhooks:manage`
`POST /webhooks`	Register an endpoint	`webhooks:manage`
`PATCH /webhooks/{webhookId}`	Change or pause an endpoint	`webhooks:manage`
`DELETE /webhooks/{webhookId}`	Remove an endpoint	`webhooks:manage`
`POST /webhooks/{webhookId}/test`	Send a test ping	`webhooks:manage`
`GET /webhooks/{webhookId}/deliveries`	The endpoint's last 25 deliveries	`webhooks:manage`
`POST /webhooks/{webhookId}/rotate-secret`	Rotate the signing secret	`webhooks:manage`

Money#

The balance, transactions, earnings, statements, payout methods and payouts. All of Money.

Endpoint	What it does	Scope
`GET /balance`	The balance, per currency	`finance:read`
`GET /transactions`	Ledger entries	`finance:read`
`GET /earnings`	Earnings by month, release, track, store or territory	`finance:read`
`GET /statements`	Published royalty statements	`finance:read`
`GET /statements/{statementId}`	One statement	`finance:read`
`GET /statements/{statementId}/lines`	The royalty lines behind a statement	`finance:read`
`GET /statements/{statementId}/export`	The statement's lines as CSV	`finance:read`
`GET /payout-methods`	Saved payout methods	`finance:read`
`GET /payouts`	Payout requests	`finance:read`
`GET /payouts/{payoutId}`	One payout request	`finance:read`
`POST /payouts`	Request a payout	`payouts:write`
`POST /payouts/{payoutId}/cancel`	Cancel a pending payout	`payouts:write`

Smart links#

A release's smart link page and how many people it brought. All of Smart links.

Endpoint	What it does	Scope
`GET /releases/{releaseId}/smart-link`	The release's smart link	`releases:read`
`PUT /releases/{releaseId}/smart-link`	Make or change the smart link	`releases:write`
`GET /releases/{releaseId}/smart-link/stats`	Clicks and sign-ups	`releases:read`

Cover licences#

Licences for cover songs: asking for one, documents and cancelling. All of Cover licences.

Endpoint	What it does	Scope
`GET /cover-licenses`	Cover licence requests	`releases:read`
`GET /cover-licenses/{licenseId}`	One request	`releases:read`
`POST /cover-licenses`	Ask for a cover licence	`releases:write`
`POST /cover-licenses/{licenseId}/document`	Start uploading the licence file	`releases:write`
`POST /cover-licenses/{licenseId}/document/complete`	Finish uploading the licence file	`releases:write`
`POST /cover-licenses/{licenseId}/cancel`	Cancel a request not sent in yet	`releases:write`

Sandbox#

Calls that play review, the stores and payouts, for sandbox keys only. All of Sandbox.

Endpoint	What it does	Scope
`POST /sandbox/releases/{releaseId}/review`	Play review	`releases:read`
`POST /sandbox/releases/{releaseId}/deliver`	Play delivery	`releases:read`
`POST /sandbox/royalties`	Play a royalty month	`finance:read`
`POST /sandbox/payouts/{payoutId}/pay`	Play paying a payout	`finance:read`
`POST /sandbox/reset`	Empty the sandbox	Any key