Public Documentation

API Docs By Role

Brand DocsBrand Login
Routing Structure

Each role now has a dedicated docs path.

API documentation is organized under a stable public route pattern so teams can link directly to the role they need and expand endpoint coverage without mixing brand, athlete, gym, or admin examples together.

Route Pattern
/api-docs/<role>

Example role routes: `/api-docs/brand`, `/api-docs/athlete`, `/api-docs/gym`, and `/api-docs/admin`.

Content Model
  • Auth and header requirements stay at the top of every role page.
  • Endpoints, examples, and errors are grouped only within that role.
  • Future routes can go live without changing the hub URL structure.
Machine-Readable Route Map

Agents and internal tooling can parse this summary to discover stable public docs routes by role without scraping the full page.

script#api-docs-route-map[type="application/json"]

The embedded manifest contains the docs base path plus role URLs and availability state for each role.

Inspect Route Map JSONOptional
{
  "docsBasePath": "/api-docs",
  "roles": [
    {
      "description": "Profile, product CRUD, coupon code CRUD, concrete cURL requests, and JSON examples.",
      "role": "brand",
      "status": "Available",
      "url": "/api-docs/brand"
    },
    {
      "description": "Reserved for athlete API auth, proof submission endpoints, rewards, and future response examples.",
      "role": "athlete",
      "status": "Coming Soon",
      "url": "/api-docs/athlete"
    },
    {
      "description": "Reserved for gym verification endpoints, queue operations, and future request and error examples.",
      "role": "gym",
      "status": "Coming Soon",
      "url": "/api-docs/gym"
    },
    {
      "description": "Reserved for internal admin endpoints and operational workflows when those APIs are documented.",
      "role": "admin",
      "status": "Coming Soon",
      "url": "/api-docs/admin"
    }
  ]
}
Role Index

Role-specific docs and reserved routes

Public links that can be shared directly.
Brand API Docs
Available
/api-docs/brand

Profile, product CRUD, coupon code CRUD, concrete cURL requests, and JSON examples.

Open Brand Docs
Athlete API Docs
Coming Soon
/api-docs/athlete

Reserved for athlete API auth, proof submission endpoints, rewards, and future response examples.

Open Athlete Docs
Gym API Docs
Coming Soon
/api-docs/gym

Reserved for gym verification endpoints, queue operations, and future request and error examples.

Open Gym Docs
Admin API Docs
Coming Soon
/api-docs/admin

Reserved for internal admin endpoints and operational workflows when those APIs are documented.

Open Admin Docs