> ## 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. # API Overview > Introduction to the BeatPass API for approved developer integrations. The BeatPass API provides access to platform data for approved developer integrations and partnerships. All authenticated requests use Bearer token authentication. API access is **invite-only**. Developer tokens are granted on a case-by-case basis. To request access, contact [**contact@beatpass.ca**](mailto:contact@beatpass.ca). See [Authentication](/developers/auth) for details. ## Quick Links Get up and running quickly Learn the auth flow Explore all endpoints *** ## Integration Requests If you're interested in integrating with BeatPass (partnerships, data licensing, embedded players), contact support to discuss options. Contact support for integration discussions. *** ## Base URL All API requests use the base URL: ``` https://open.beatpass.ca/api/v1 ``` *** ## API Surface The BeatPass API provides comprehensive functionality across the platform: List, view, upload, update, delete tracks Album management and metadata Artist profiles, followers, tracks Create, manage, share playlists Full-text search across content types Genre listing and filtering Synced and plain lyrics management Personalized music recommendations Per-track purchase and license flow Generate, verify, revoke licenses Preset management for exclusive sales Artist earnings from subscriptions Read-only payout summaries where documented; setup stays in **Finances** Discount code management XP, achievements, leaderboards Track performance, engagement metrics Earnings estimates, track breakdowns History, projections, trends Duplicate detection, content ID Detected audio similarities on streaming platforms Backstage submission status checks and conflict guidance Template-based cover art generation Professional portfolio credits Direct messages with typing indicators Custom beat request marketplace User and artist follow system Content sharing within platform Curated content collections Liked tracks, albums, and artists *** ## Request Format ### HTTP Methods Retrieve data Create resources Update resources Remove resources ### Required Headers ```http theme={"theme":{"light":"github-light","dark":"one-dark-pro"}} Accept: application/json Content-Type: application/json ``` Authenticated requests must include a valid Bearer token. See the [Authentication guide](/developers/auth) for details. *** ## Response Format ### Success Response Responses vary by endpoint. Most return data directly: ```json theme={"theme":{"light":"github-light","dark":"one-dark-pro"}} { "id": 1234, "name": "Track Name", "artist": {...} } ``` ### Error Response ```json theme={"theme":{"light":"github-light","dark":"one-dark-pro"}} { "message": "Error description", "errors": { "field": ["Validation error"] } } ``` ### Pagination Paginated endpoints use standard cursor-based pagination: ```json theme={"theme":{"light":"github-light","dark":"one-dark-pro"}} { "data": [...], "current_page": 1, "per_page": 15, "total": 150, "last_page": 10, "links": {...} } ``` *** ## Authentication & Data Access The BeatPass API uses a **two-tier access model** for external consumers: | Tier | Auth | Data | | ---------- | ---------------- | ------------------------------------- | | **Public** | None | Minimal (id, name, model\_type only) | | **Token** | `Bearer {token}` | Rich (pricing, plays, BPM, licensing) | **Unauthenticated requests return minimal data.** You must have an approved Bearer token to access rich API responses. See [Authentication](/developers/auth) for details. ```mermaid theme={"theme":{"light":"github-light","dark":"one-dark-pro"}} flowchart LR A[API Request] --> B{Bearer token\nincluded?} B -->|Yes| C[Rich Data\nPricing, plays, BPM,\nlicensing, tags] B -->|No| D[Minimal Data\nid, name, model_type] ``` *** ## Endpoint Categories The API provides read access to public content (tracks, artists, albums, genres, search) and authenticated access to user-specific features (library, playlists, messaging, purchases, analytics). See the [API Reference](/developers/api-reference/overview) for the full endpoint listing. *** ## Rate Limiting The API enforces rate limits to ensure fair usage and platform stability. Exceeding limits returns a `429 Too Many Requests` response. View rate limiting documentation and best practices. *** ## Terms of Use API access is subject to the BeatPass Terms of Service. The following are strictly prohibited: * **Scraping or crawling** platform content * **Bypassing** rate limits or access controls * **Accessing** undocumented or internal endpoints * **Redistributing** API data without permission * **Automated bulk collection** of catalog data Violations result in immediate token revocation and account termination. Found a security issue? Report it responsibly to [**contact@beatpass.ca**](mailto:contact@beatpass.ca) — we appreciate responsible disclosure. *** ## Next Steps Learn how API authentication works. Complete endpoint reference.