Skip to main content

​
API Reference

This section documents all public-facing BeatPass API endpoints. Browse the OpenAPI specification or explore specific API domains:

​
API Documentation

Dashboard API

Producer dashboard metrics, track performance, and upload insights.

Insights API

Analytics and insights for tracks, albums, and artists.

​
OpenAPI Explorer

The API reference uses the BeatPass OpenAPI specification to provide interactive documentation for all endpoints. Browse by category in the Endpoint Explorer section of the navigation.
Base URL: https://open.beatpass.ca/api/v1

​
Using the API Explorer

1

Select an Endpoint

Expand the Endpoint Explorer in the sidebar and choose a category:
  • Search — Full-text search across content
  • Tracks — Track listing, details, and management
  • Artists — Artist profiles and followers
  • Albums — Album management
  • Playlists — Playlist CRUD and collaboration
  • License Certificates — License generation and verification
  • And more…
2

Review Parameters

Each endpoint shows required and optional parameters, request body schemas, and example values.
3

Try It Out

Use the Try It feature to make live API calls. Note that authenticated endpoints require a valid session (see Authentication).
4

Check Responses

Response schemas show the expected data structure. Error responses (401, 403, 404, 422) are documented for each endpoint.

​
Authentication Note

BeatPass uses cookie-based session authentication, not Bearer tokens. The OpenAPI explorer’s “Set authentication” feature is primarily for documentation purposes. To make authenticated requests:
  1. Authenticate via the standard login flow (see Authentication)
  2. Include credentials: 'include' in fetch requests to send session cookies
The API does not accept Bearer tokens. All authentication is handled via Sanctum session cookies.

​
Quick Examples

​
Public Endpoint (No Auth)

# Search for tracks (works without authentication)
curl "https://open.beatpass.ca/api/v1/search?query=lofi&types=track&limit=5" \
  -H "Accept: application/json"

​
Authenticated Endpoint

// JavaScript with session cookies
const response = await fetch('https://open.beatpass.ca/api/v1/messaging/conversations', {
  method: 'GET',
  headers: {
    'Accept': 'application/json'
  },
  credentials: 'include' // Required for session cookies
});

​
Endpoint Categories

These endpoints work without authentication (enhanced data when logged in):

Search

Optional Auth Full-text search across all content types.

Tracks

Read: Optional Track listing and details.

Artists

Read: Optional Artist profiles and followers.

Albums

Read: Optional Album listing and metadata.
The Insights API provides focused, domain-specific analytics endpoints with standardized error handling and export capabilities.

Authentication

Understand session-based authentication.

Error Catalog

Error codes and resolutions.
Last modified on December 5, 2025