Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.beatpass.ca/llms.txt

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

​
Overview

This guide helps approved developers get started with the BeatPass API.
API access is invite-only. Developer tokens are granted on a case-by-case basis. To request access, contact contact@beatpass.ca. See Authentication for details.

​
Authentication

All API requests use Bearer token authentication: 
GET /api/v1/tracks
Authorization: Bearer {your-token}
Accept: application/json
DetailValue
AccessInvite-only, granted by BeatPass team
Token expiration90 days from creation
Data accessToken required for rich API responses
Unauthenticated requests return minimal data (id, name, model_type only). A valid Bearer token is required for rich responses with pricing, plays, BPM, and licensing info.

​
Environment

​
No Public Sandbox

No Public Sandbox — BeatPass does not provide a public sandbox or test environment. All API calls hit production systems.
This means:
ActionImpact
POST/PUT/DELETE requestsReal data is modified
PurchasesReal charges occur
UploadsReal content is published
MessagesReal users receive messages

​
Development Best Practices

PracticeWhy
Use personal test accountsAvoid affecting real users
Test with minimal dataDon’t create spam content
Clean up test dataDelete test uploads promptly
Never test payments with real cardsUse Stripe test mode when available

​
Using Placeholder IDs

When developing or documenting:
EntityPlaceholder FormatExample
Track ID{track_id}/tracks/{track_id}
User ID{user_id}/users/{user_id}
Artist ID{artist_id}/artists/{artist_id}
Album ID{album_id}/albums/{album_id}

​
In Code Examples

// Good - uses placeholder
const trackId = process.env.TEST_TRACK_ID || '{track_id}';

// Bad - hardcodes production ID
const trackId = 12345;

​
In Documentation

GET /api/v1/tracks/{track_id}
Not: 
GET /api/v1/tracks/12345

​
Restricted Access

Undocumented endpoints are off-limits. Unauthorized access attempts are logged, monitored, and may result in immediate token revocation and account termination.
If you encounter a 403 Forbidden response, the endpoint requires permissions your account does not have. Contact support if you believe this is an error.

​
Safe API Usage

​
Do

  • Use documented endpoints only
  • Respect rate limits
  • Handle errors gracefully
  • Clean up test data
  • Log responsibly (no sensitive data)

​
Don’t

  • Scrape or crawl the platform
  • Hammer endpoints with excessive requests
  • Store user credentials
  • Bypass authentication
  • Share authentication credentials

​
Error Handling

​
Standard Error Format

{
  "message": "Human-readable error",
  "errors": {
    "field": ["Validation error message"]
  }
}

​
HTTP Status Codes

CodeMeaningAction
200SuccessProcess response
201CreatedResource created
400Bad RequestFix request format
401UnauthorizedRe-authenticate
403ForbiddenCheck permissions
404Not FoundResource doesn’t exist
422Validation ErrorFix input data
429Rate LimitedBack off and retry
500Server ErrorReport to support
See Error Catalog for feature-specific errors.

​
Getting Help

TopicContact
API questionscontact@beatpass.ca
Security concernscontact@beatpass.ca
Partnership inquiriescontact@beatpass.ca

​
Documentation

TopicLocation
API Overview/developers/overview
API Reference/developers/api-reference/overview
Authentication/developers/auth
Rate Limits/developers/rate-limits
Error Catalog/developers/error-catalog

​
Getting Started Checklist

1

Request API Access

Contact contact@beatpass.ca with your use case and organization details.
2

Generate Token

Once approved, go to Account Settings → Developers to create your token.
3

Review Documentation

4

Start Building

  • Begin with read-only endpoints (tracks, artists, search)
  • Use placeholder IDs in development
  • Monitor rate limit headers
  • Handle errors gracefully

API Overview

Full API introduction.

Error Catalog

Error codes and resolutions.
Last modified on February 7, 2026