API Reference

Base URL

https://api.fluxrate.co/api/v1

For self-hosted deployments:

http://localhost:8000/api/v1

Fluxrate uses two authentication methods:

Include the access_token cookie obtained from the login endpoint:

curl https://api.fluxrate.co/api/v1/customers \
  -H "Cookie: access_token=eyJ..."

Browsers set cookies automatically. For programmatic access, store and send the cookie manually.

All responses use JSON. List endpoints return paginated results:

{
  "data": [...],
  "meta": {
    "page": 1,
    "page_size": 20,
    "total": 342,
    "total_pages": 18
  }
}

{
  "detail": "Customer not found"
}

Code	Meaning
`200`	Success
`201`	Created
`204`	No Content (successful delete)
`400`	Bad Request — invalid parameters
`401`	Unauthorized — missing or invalid auth
`403`	Forbidden — insufficient permissions
`404`	Not Found
`409`	Conflict — duplicate resource
`422`	Unprocessable Entity — validation error
`500`	Internal Server Error

All list endpoints support:

Parameter	Default	Max	Description
`page`	1	—	Page number (1-indexed)
`page_size`	20	100	Items per page

Access the interactive Swagger UI:

http://localhost:8000/docs

Or ReDoc:

http://localhost:8000/redoc

The current API version is v1. All endpoints are prefixed with /api/v1.