DEVELOPER API

Supplier Integration API

Connect your supplier systems directly to GymAxis AI for seamless equipment management, issue tracking, and service coordination.

Getting Started

1. Generate API Key

Log into your GymAxis AI dashboard and navigate to Settings \u2192 API Keys. Click "Generate New API Key" and store it securely.

API Key Format: gfx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

2. Authentication

Include your API key in the X-API-Key header with every request:

curl -X GET "https://gymaxisai.com/api/v1/supplier/equipment" \
  -H "X-API-Key: gfx_your_api_key_here"

3. Base URL

https://gymaxisai.com/api/v1/supplier

GET

/equipment

List All Equipment

Retrieve all equipment for the authenticated customer

Response:

{
  "equipment": [
    {
      "id": "uuid",
      "name": "Treadmill 1",
      "equipment_type": "Treadmill",
      "manufacturer": "Life Fitness",
      "model": "T5-Go",
      "serial_number": "SN123456",
      "stats": {
        "total_issues": 3,
        "open_issues": 1,
        "total_audits": 2
      }
    }
  ],
  "count": 1
}

GET

/equipment/{equipment_id}

Get Equipment Details

Get detailed information about specific equipment including issue history

Response:

{
  "id": "uuid",
  "name": "Treadmill 1",
  "equipment_type": "Treadmill",
  "manufacturer": "Life Fitness",
  "stats": {...},
  "issues": [...]
}

POST

/equipment

Create Equipment

Add new equipment to customer site (useful when installing new machines)

Request Body:

{
  "name": "Treadmill 2",
  "equipment_type": "Treadmill",
  "manufacturer": "Life Fitness",
  "model": "T5-Go",
  "serial_number": "SN789012",
  "warranty_expiry": "2027-12-31"
}

PATCH

/equipment/{equipment_id}

Update Equipment

Update equipment details

Request Body:

{
  "notes": "Belt replaced on 2026-04-03",
  "warranty_expiry": "2028-04-03"
}

Best Practices

\u2022Store API keys securely - Never commit keys to version control
\u2022Use webhooks for real-time updates instead of polling
\u2022Handle errors gracefully - Check HTTP status codes and error messages
\u2022Rate limit: 1000 requests per hour per API key

Need Help?

Our integration team is here to help you get connected

Email: api@gymaxisai.com

We use essential cookies to keep you signed in and provide core functionality. We do not use tracking or advertising cookies. Privacy Policy