Core concepts - Gymdesk API

Pagination

The API uses two pagination styles. The endpoint decides which one applies.

Page-based
Cursor-based

Most list endpoints take page and perPage query parameters. They return a meta block with the current page and the total, plus a links block with first, last, prev, and next URLs. perPage defaults to 100, and 100 is also the maximum.Page-based endpoints: /academies, /memberships, /members/{memberId}/memberships, and /attendance.

/transactions is cursor-paginated. Each response returns meta.nextCursor. Pass that value back as the cursor query parameter to get the next page. Stop when nextCursor comes back null. Cursor pagination has no total and no last-page count, so you walk forward. perPage still controls the page size.

# Pass nextCursor back until it is null.
cursor = null
do
  page = GET /transactions?paidFrom=2026-06-01&paidTo=2026-06-30&cursor={cursor}
  process(page.data)
  cursor = page.meta.nextCursor
while cursor != null

Amounts and currency

Money appears in two encodings. Read the wrong one and your totals come out wrong by a factor of 100, so check which one applies.

Encoding	Shape	Where it appears
Minor units	`integer`	Transaction and summary amounts: `amount`, `tax1`, `tax2`, `processingFee`, `total`
Money object	`object`	Membership pricing, credit balance, discounts

A minor-units value is a signed integer in the currency’s ISO 4217 minor unit. It can go negative on refunds and chargebacks. A Money object carries a decimal amount in major units plus a currency code.

A transaction with "total": 5000 and "currency": "USD" is

50.00, not

5,000. Divide by the minor-unit factor for the currency, which is 100 for USD. For zero-decimal currencies such as JPY the minor unit is the whole unit, so 5000 is Y5000. For KWD, which has three decimals, 5000 is 5.000 KWD.

Errors

An error returns a JSON body with a message and a correlationId. Quote the correlationId to Gymdesk support to trace a request. A validation failure also returns a field-level errors map.

Status	Meaning
401	The API key is missing or invalid.
404	The resource does not exist, or it sits outside your key’s scope.
409	The resource already exists. Today only `POST /members/{memberId}/tags` returns this.
422	Validation failed. Read the `errors` map for the fields at fault.

{
  "message": "Validation failed",
  "errors": { "paidTo": ["Field is required"] },
  "correlationId": "01890c1a-9b2d-7c3e-8f12-3456789abcde"
}

The API returns 404 for a resource in an academy your key cannot reach. It does not return 403, so a resource in another academy stays undetectable. The same correlation ID comes back in the GD-Correlation-Id response header.

​Pagination

​Amounts and currency

​Errors

Pagination

Amounts and currency

Errors