Scopes
Rate limits
All resource calls use the standard Public API Bearer-token rate limit. Responses include the current rate-limit headers when rate limiting is enabled:Company profile
company_catalog:read
Response fields:
Omitted: VAT number, company registration number, billing details, payment
provider details, invoice settings, and external reference IDs.
Facilities and services
company_catalog:read
Response fields:
Company policies
company_catalog:read
Response fields:
Policy content follows the localized text contract.
Reads expose stored languages only. Use the FITsociety coach dashboard to edit
policies; Public API policy writes are unavailable.
Locations
locations:read for reads, locations:write for writes.
Archiving returns HTTP 409 LOCATION_IN_USE while members or ongoing products
or subscriptions still use the location as their home location. Pending and
paused records also block archiving. Reassign these links in the coach
application before retrying. Successful archiving clears scheduling
availability links; historical financial records, scheduled lessons and
bookings are preserved.
List responses include pagination fields:
Location fields:
Validation:
Archive returns the archived location. Archived locations are excluded from
list and get responses.
List locations example
Create location example
201 Created):
Archive location example
Archive is an action route (POST .../archive), not a DELETE. Empty request
bodies are accepted; the Idempotency-Key header is still required.