REST, JSON, snake_case. Cursor pagination. RFC 7807 errors. No per-call billing in any tier. Public read-only widgets live under /public/v1. Every write that charges, checks in, or promotes accepts an Idempotency-Key header (24h dedupe). Versioning is in the URI (/v1); deprecations ship with a Sunset header and a 12-month window.
Schemas
Problem
{
"type": "object",
"required": [
"type",
"title",
"status"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string"
},
"status": {
"type": "integer"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"code": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}Pagination
{
"type": "object",
"properties": {
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer"
},
"has_more": {
"type": "boolean"
}
}
}TokenRequest
{
"type": "object",
"required": [
"grant_type"
],
"properties": {
"grant_type": {
"type": "string",
"enum": [
"client_credentials",
"refresh_token",
"authorization_code"
]
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"scope": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"code": {
"type": "string"
},
"code_verifier": {
"type": "string"
},
"gym_id": {
"type": "string",
"format": "uuid"
}
}
}TokenResponse
{
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"expires_in": {
"type": "integer"
},
"refresh_token": {
"type": "string"
},
"scope": {
"type": "string"
}
}
}Gym
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"legal_name": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string"
},
"locale": {
"type": "string"
},
"brand_primary": {
"type": [
"string",
"null"
]
},
"logo_url": {
"type": [
"string",
"null"
]
},
"payment_processor": {
"type": "string"
},
"settings": {
"type": "object"
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
}GymPatch
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"legal_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"website": {
"type": "string"
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string"
},
"brand_primary": {
"type": "string"
},
"logo_url": {
"type": "string"
},
"payment_processor": {
"type": "string"
},
"settings": {
"type": "object",
"description": "Partial merge; keys: lead_assignment, self_serve_drop_in, holidays, surcharge, tax, google_review_url, sms_templates, waiver_revalidate_months, early_termination_fee_cents, kiosk, email_branding, safesport, schedule, dunning, brand_colors"
}
}
}Location
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"address_line1": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"postal_code": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": "string"
},
"is_primary": {
"type": "boolean"
},
"geo_lat": {
"type": [
"number",
"null"
]
},
"geo_lng": {
"type": [
"number",
"null"
]
},
"geofence_radius_m": {
"type": [
"integer",
"null"
]
}
}
}LocationInput
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"address_line1": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"country": {
"type": "string"
},
"timezone": {
"type": "string"
},
"is_primary": {
"type": "boolean"
},
"geo_lat": {
"type": "number"
},
"geo_lng": {
"type": "number"
},
"geofence_radius_m": {
"type": "integer"
}
}
}Member
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"preferred_name": {
"type": [
"string",
"null"
]
},
"dob": {
"type": [
"string",
"null"
],
"format": "date"
},
"email": {
"type": [
"string",
"null"
]
},
"phone_e164": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"prospect",
"trial",
"active",
"frozen",
"cancelled",
"archived"
]
},
"photo_url": {
"type": [
"string",
"null"
]
},
"joined_date": {
"type": "string",
"format": "date"
},
"custom_fields": {
"type": "object"
},
"external_ids": {
"type": "object"
},
"last_check_in_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lifetime_check_in_count": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}MemberInput
{
"type": "object",
"required": [
"first_name",
"last_name"
],
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"preferred_name": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"email": {
"type": "string"
},
"phone_e164": {
"type": "string"
},
"emergency_contacts": {
"type": "array",
"items": {
"type": "object"
}
},
"custom_fields": {
"type": "object"
},
"external_ids": {
"type": "object"
}
}
}Lead
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone_e164": {
"type": [
"string",
"null"
]
},
"source": {
"type": "string"
},
"status": {
"type": "string"
},
"pipeline_stage_id": {
"type": [
"string",
"null"
]
},
"score": {
"type": "integer"
}
}
}LeadInput
{
"type": "object",
"required": [
"first_name"
],
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_e164": {
"type": "string"
},
"source": {
"type": "string"
},
"interested_in": {
"type": "array",
"items": {
"type": "string"
}
},
"utm": {
"type": "object"
}
}
}EmailSend
{
"type": "object",
"properties": {
"member_id": {
"type": "string"
},
"lead_id": {
"type": "string"
},
"email": {
"type": "string"
},
"subject": {
"type": "string"
},
"html": {
"type": "string"
},
"template_id": {
"type": "string"
},
"tokens": {
"type": "object"
},
"category": {
"type": "string",
"enum": [
"transactional",
"marketing",
"reminder"
]
}
}
}SmsSend
{
"type": "object",
"properties": {
"member_id": {
"type": "string"
},
"lead_id": {
"type": "string"
},
"phone_e164": {
"type": "string"
},
"body": {
"type": "string"
},
"template_id": {
"type": "string"
},
"cc_parent": {
"type": "boolean",
"description": "Required true when the member is a minor"
},
"category": {
"type": "string"
}
}
}BroadcastInput
{
"type": "object",
"required": [
"channel",
"body"
],
"properties": {
"channel": {
"type": "string",
"enum": [
"email",
"sms",
"push"
]
},
"segment_id": {
"type": "string"
},
"filter": {
"type": "object"
},
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"schedule_at": {
"type": "string",
"format": "date-time"
},
"preview": {
"type": "boolean"
}
}
}Broadcast
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"channel": {
"type": "string"
},
"status": {
"type": "string"
},
"recipient_count": {
"type": "integer"
},
"sent_count": {
"type": "integer"
},
"failed_count": {
"type": "integer"
},
"sent_at": {
"type": [
"string",
"null"
]
}
}
}WorkflowInput
{
"type": "object",
"required": [
"name",
"trigger_type"
],
"properties": {
"name": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"trigger_config": {
"type": "object"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"config": {
"type": "object"
}
}
}
}
}
}Workflow
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": "integer"
},
"steps": {
"type": "array",
"items": {
"type": "object"
}
}
}
}Staff
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"status": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object"
}
},
"hire_date": {
"type": [
"string",
"null"
]
}
}
}Report
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time"
},
"params": {
"type": "object"
},
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"rows": {
"type": "array",
"items": {
"type": "object"
}
},
"meta": {
"type": "object"
}
}
}WebhookEnvelope
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"data": {
"type": "object"
}
}
}