Getting started - Gymdesk API

Base URL and environments

All requests go to the production host. Prefix every path with the base URL.

Environment	Base URL
Production	`https://api.gymdesk.com`
Development	`https://api.gymdesk.test` (internal only)

Authentication

Send your API key in the X-API-Key header on every request. There is no OAuth handshake and no per-request signing.

X-API-Key: gd_1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890

A Gymdesk API key starts with gd_ and carries 64 hexadecimal characters.

An API key carries the access of the academies it is scoped to. Store it as a secret in the system that consumes the API. Do not commit it to source control.

Getting an API key

Gymdesk issues API keys. Your Gymdesk contact generates a key for your academies and shares it with you securely. You do not create the key yourself, and you do not enter it into Gymdesk. The key lives wherever you consume the API from.

Ask for a key

Ask your Gymdesk contact for a key scoped to the academies you want to read.

Confirm its scope

Confirm the academies the key covers with GET /me.

Store it

Store the key in your integration, for example your accounting tool or Zapier.

Gymdesk shows the key one time only, when it creates or regenerates it. Gymdesk stores just a hash of the key, so nobody can show it to you again.

Your first request

Call GET /me to confirm your key works and to see what it can access.

curl https://api.gymdesk.com/me \
  -H "X-API-Key: gd_your_api_key_here"

{
  "data": {
    "id": 42,
    "name": "My Production Key",
    "academyIds": [999],
    "user": { "id": 7, "name": "Jane Doe", "email": "jane@example.com" }
  }
}

academyIds lists the academies the key can read. The list is already resolved, so it names every academy the key reaches. An empty list means the key reaches no academy at all, and every scoped request returns 404.

​Base URL and environments

​Authentication

​Getting an API key

​Your first request

Base URL and environments

Authentication

Getting an API key

Your first request