API Reference

Welcome to the RadioSaaS API documentation. Our RESTful API allows you to build custom mobile applications and integrations on top of your radio platform.

Base URL

All API requests should be made to:

https://your-domain.com/api/v1

Authentication

RadioSaaS uses Laravel Sanctum (opens in a new tab) for authentication. Most endpoints require a valid Bearer token.

To get a token, you must first register or login via the Authentication endpoints.

Response Format

All API responses follow a standard JSON structure:

{
  "success": true, // or false
  "message": "Operation successful", // Optional message
  "data": { ... } // The actual data payload
}

Error Handling

Errors are returned with standard HTTP status codes and a consistent JSON format:

{
  "success": false,
  "message": "Error description",
  "errors": {
    "field_name": ["Specific validation error"]
  }
}

Available Resources

Explore the endpoints for each core resource:

• Authentication - User registration, login, and profile management
• Radio Channels - Listing, playing, and interacting with stations
• Genres - Browsing content categories
• Playlists - Managing user playlists
• Favorites - User favorites management
• Search - Global search functionality