API Documentation

Practical integration guide. Looking for the full schema? View the API reference.

1

Get Access

Create an API key in your account settings.

API Keys
2

Authenticate

Send your key using token auth in the Authorization header.

Authorization: Token YOUR_API_KEY
3

Start Calling

Use the base URL and list endpoints to integrate quickly.

https://jukehouse.fm/api/v1/

Quickstart

Example request:

curl -H "Authorization: Token YOUR_API_KEY" \
https://jukehouse.fm/api/v1/songs/

Example paginated response:

{
  "count": 42,
  "next": "https://jukehouse.fm/api/v1/songs/?limit=20&offset=20",
  "previous": null,
  "results": []
}

Request Patterns

  • limit / offset for pagination
  • search for text search on supported resources
  • ordering for sorting, prefix with -

Common status codes:

200 success
201 created
400 validation error
401 missing/invalid auth
403 forbidden

Endpoint Index

Organized by resource group and generated from the live public OpenAPI schema.

Full Reference

Browse every endpoint, parameter, and response shape in the interactive schema reference.

Open API reference