Good MMA API

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.

Base URL: https://mma-pearl-nine.vercel.app/api · openapi.json · Auth: bearer API key (mma_sk_…) or OAuth 2.0 client credentials at /v1/auth/token.

Conventions

Auth

post/v1/auth/loginPUBLIC

Email + password login (staff). Returns access + refresh tokens and sets the session cookie.

Request body
{
 "type": "object",
 "required": [
  "email",
  "password"
 ],
 "properties": {
  "email": {
   "type": "string"
  },
  "password": {
   "type": "string"
  },
  "gym_slug": {
   "type": "string"
  },
  "totp_code": {
   "type": "string"
  }
 }
}
post/v1/auth/tokenPUBLIC

OAuth 2.0 token endpoint: client_credentials, refresh_token, authorization_code (PKCE)

Request body
{
 "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"
  }
 }
}
get/v1/auth/authorizePUBLIC

Authorization endpoint (PKCE) for member apps

Parameters (5)
  • client_id (query)
  • redirect_uri (query)
  • code_challenge (query)
  • code_challenge_method (query)
  • state (query)
post/v1/auth/revokePUBLIC

Revoke a refresh token (or all sessions)

Request body
{
 "type": "object",
 "properties": {
  "token": {
   "type": "string"
  },
  "all": {
   "type": "boolean"
  }
 }
}
post/v1/auth/logoutPUBLIC

Clear the session cookie

Request body
{
 "type": "object"
}
get/v1/auth/me

Current caller context (staff, member, or API key) with permissions and gym

post/v1/auth/setup-passwordPUBLIC

Complete a staff invite by setting a password

Request body
{
 "type": "object",
 "required": [
  "token",
  "password"
 ],
 "properties": {
  "token": {
   "type": "string"
  },
  "password": {
   "type": "string"
  }
 }
}

Gyms

get/v1/gyms/me

The caller's gym with locations and settings

patch/v1/gyms/{id}

Update gym profile and settings (JSON or multipart with `logo`)

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "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"
  }
 }
}
get/v1/gyms/{id}/locations

List locations

Parameters (3)
  • id (path)
  • cursor
  • limit
post/v1/gyms/{id}/locations

Create a location

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "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"
  }
 }
}
patch/v1/locations/{id}

Update a location

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "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"
  }
 }
}
delete/v1/locations/{id}

Delete a non-primary location with no upcoming classes

Scopes: settings.write

Parameters (1)
  • id (path)

Members

get/v1/members

List members (cursor paginated, filterable)

Scopes: member.read

Parameters (8)
  • cursor
  • limit
  • search (query)
  • status (query)
  • tag (query)
  • filter[status] (query)
  • filter[joined_date][gte] (query)
  • include (query)
post/v1/members

Create a member

Scopes: member.write

Parameters (1)
  • idempotencyKey
Request body
{
 "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"
  }
 }
}
get/v1/members/{id}

Get a member

Scopes: member.read

Parameters (1)
  • id (path)
patch/v1/members/{id}

Update a member

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "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"
  }
 }
}
delete/v1/members/{id}

Soft delete (sets archived_at)

Scopes: member.delete

Parameters (1)
  • id (path)
post/v1/members/{id}/restorePLANNED

Restore an archived member

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/members/{id}/avatarPLANNED

Upload avatar (multipart)

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/members/{id}/timelinePLANNED

Unified activity timeline

Scopes: member.read

Parameters (1)
  • id (path)
post/v1/members/{id}/notesPLANNED

Add a note

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/members/{id}/tagsPLANNED

Add tags

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/members/{id}/tags/{tag_id}PLANNED

Remove a tag

Scopes: member.write

Parameters (2)
  • id (path)
  • tag_id (path)
post/v1/members/bulkPLANNED

Bulk import (CSV) with vendor presets

Scopes: member.write

Request body
{
 "type": "object"
}
get/v1/members/{id}/waiversPLANNED

Waiver signing status

Scopes: member.read

Parameters (1)
  • id (path)
get/v1/members/{id}/householdPLANNED

Household for a member

Scopes: member.read

Parameters (1)
  • id (path)

Billing

get/v1/members/{id}/balancePLANNED

Ledger balance

Scopes: invoice.read

Parameters (1)
  • id (path)
post/v1/members/{id}/creditsPLANNED

Issue account credit

Scopes: invoice.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/payment-methodsPLANNED

Attach a tokenized payment method (never PAN)

Scopes: payment.charge

Request body
{
 "type": "object"
}
delete/v1/payment-methods/{id}PLANNED

Remove a payment method

Scopes: payment.charge

Parameters (1)
  • id (path)
get/v1/invoices

List invoices

Scopes: invoice.read

post/v1/invoices

Create an ad-hoc invoice

Scopes: invoice.write

Parameters (1)
  • idempotencyKey
Request body
{
 "type": "object"
}
get/v1/invoices/{id}PLANNED

Invoice detail with lines and payments

Scopes: invoice.read

Parameters (1)
  • id (path)
post/v1/invoices/{id}/payPLANNED

Charge the default (or given) payment method

Scopes: payment.charge

Parameters (2)
  • id (path)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/invoices/{id}/refundPLANNED

Refund (max = sum of successful payments)

Scopes: payment.refund

Parameters (2)
  • id (path)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/invoices/{id}/voidPLANNED

Void an open invoice

Scopes: payment.void

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/paymentsPLANNED

Payments by member / range

Scopes: invoice.read

Parameters (2)
  • member_id (query)
  • date_range (query)
get/v1/statements/current

Itemized monthly platform statement (no blended rates)

Scopes: invoice.read

Attendance

get/v1/members/{id}/attendancePLANNED

Attendance history

Scopes: attendance.read

Parameters (1)
  • id (path)
post/v1/attendance

Record a check-in (idempotent on member + class instance)

Scopes: attendance.write

Parameters (1)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/kiosk/check-inPUBLIC

Kiosk check-in by PIN / QR / barcode with actionable alerts

Request body
{
 "type": "object"
}
post/v1/attendance/backdatedPLANNED

Backdated check-in (audit logged)

Scopes: attendance.backdate

Request body
{
 "type": "object"
}
get/v1/attendance/since-last-promotionPLANNED

Attendance counters since last rank

Scopes: attendance.read

Parameters (2)
  • member_id (query)
  • rank_system_id (query)

Scheduling

get/v1/members/{id}/calendar.icsPUBLICPLANNED

Per-member iCal feed

Parameters (1)
  • id (path)
get/v1/class-types

Class types

Scopes: schedule.read

post/v1/class-types

Create class type (gi/no-gi flag, prerequisites)

Scopes: schedule.write

Request body
{
 "type": "object"
}
get/v1/class-schedules

Recurring schedules

Scopes: schedule.read

Parameters (3)
  • location_id (query)
  • from (query)
  • to (query)
post/v1/class-schedules

Create a recurring schedule (RFC 5545 RRULE); materializes 90 days

Scopes: schedule.write

Request body
{
 "type": "object"
}
patch/v1/class-schedules/{id}PLANNED

Update a schedule and regenerate future instances

Scopes: schedule.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/class-instances

Class instances in a window

Scopes: schedule.read

Parameters (3)
  • from (query)
  • to (query)
  • location_id (query)
post/v1/class-instances/{id}/cancel

Cancel one instance (notifies reservations)

Scopes: schedule.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/class-instances/{id}/roster

Roster with reservation + attendance status

Scopes: schedule.read

Parameters (2)
  • id (path)
  • checked_in (query)
post/v1/class-instances/{id}/reservations

Reserve (waitlist when full)

Scopes: reservation.write

Parameters (2)
  • id (path)
  • idempotencyKey
Request body
{
 "type": "object"
}
delete/v1/reservations/{id}

Cancel a reservation (late-cancel rules apply)

Scopes: reservation.write

Parameters (1)
  • id (path)

Households

post/v1/households

Create a household

Scopes: member.write

Request body
{
 "type": "object"
}
post/v1/households/{id}/membersPLANNED

Add a member to a household

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/households/{id}/members/{member_id}PLANNED

Remove a member

Scopes: member.write

Parameters (2)
  • id (path)
  • member_id (path)
post/v1/households/{id}/transfer-billingPLANNED

Change the billing payer

Scopes: membership.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Leads

post/v1/leadsPUBLIC

Create a lead (public allowed with captcha)

Request body
{
 "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"
  }
 }
}
get/v1/leads

List leads

Scopes: member.read

Parameters (2)
  • cursor
  • limit
post/v1/leads/{id}/convert

Convert lead → member (+household, waiver, membership, reservation)

Scopes: member.write

Parameters (2)
  • id (path)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/leads/{id}/contactPLANNED

Log a call/email

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/leads/{id}/losePLANNED

Mark lost with reason

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/leads/{id}/notePLANNED

Add a note

Scopes: member.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Waivers

get/v1/waivers

List waivers (versioned)

Scopes: member.read

post/v1/waivers

Create a waiver; a new version creates a new row

Scopes: settings.write

Request body
{
 "type": "object"
}
post/v1/waivers/{id}/sign

Sign (member or guest; parent for minors)

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Ranks

get/v1/disciplines

Disciplines (presets + gym custom)

get/v1/rank-systems

Rank systems

post/v1/rank-systemsPLANNED

Create a gym-custom rank system

Scopes: settings.write

Request body
{
 "type": "object"
}
get/v1/rank-systems/{id}/ranks

Ranks in a system

Parameters (1)
  • id (path)
get/v1/ranks/{id}/requirementsPLANNED

Curriculum requirements for a rank

Parameters (1)
  • id (path)
get/v1/members/{id}/ranksPLANNED

Rank history (append-only)

Scopes: rank.read

Parameters (1)
  • id (path)
post/v1/promotions

Promote one member

Scopes: rank.promote

Parameters (1)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/promotions/bulk

Bulk promotion

Scopes: rank.promote

Parameters (1)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/promotions/{id}/void

Void a promotion (append-only; never un-finalize)

Scopes: rank.void

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/members/{id}/eligibility

Eligibility for the member's next rank

Scopes: rank.read

Parameters (1)
  • id (path)
get/v1/eligibility/ready

Ready-to-promote list for a rank system

Scopes: rank.read

Parameters (2)
  • rank_system_id (query)
  • class_type_id (query)
get/v1/members/{id}/curriculum/{rank_system_id}PLANNED

Curriculum checklist

Scopes: rank.read

Parameters (2)
  • id (path)
  • rank_system_id (path)
post/v1/curriculum/sign-offPLANNED

Instructor sign-off on a requirement

Scopes: curriculum.signoff

Request body
{
 "type": "object"
}
post/v1/members/{id}/stripes

Increment stripe (sub_level)

Scopes: rank.promote

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/certificates/renderPLANNED

Render a certificate (HTML/PDF)

Scopes: rank.read

Request body
{
 "type": "object"
}

Belt tests

get/v1/belt-tests

List belt test events

Scopes: rank.read

post/v1/belt-tests

Schedule a belt test (draft)

Scopes: belt_test.write

Request body
{
 "type": "object"
}
patch/v1/belt-tests/{id}

Edit any field until finalized

Scopes: belt_test.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/belt-tests/{id}/registrations/bulk

Bulk register/invite

Scopes: belt_test.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/belt-tests/{id}/finalize

Finalize: creates StudentRank rows, certificates, notifications; locks the event

Scopes: belt_test.write

Parameters (2)
  • id (path)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/belt-tests/{id}/cancelPLANNED

Cancel an event

Scopes: belt_test.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Appointments

get/v1/appointments/availabilityPLANNED

Open slots from instructor availability windows

Scopes: schedule.read

Parameters (3)
  • type_id (query)
  • instructor_id (query)
  • date_range (query)
post/v1/appointmentsPLANNED

Book a private lesson

Scopes: reservation.write

Request body
{
 "type": "object"
}
patch/v1/appointments/{id}PLANNED

Reschedule / update

Scopes: schedule.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/appointments/{id}PLANNED

Cancel

Scopes: schedule.write

Parameters (1)
  • id (path)

Memberships

get/v1/membership-plans

Plans

post/v1/membership-plans

Create a plan

Scopes: settings.write

Request body
{
 "type": "object"
}
post/v1/memberships

Start a membership (trial/active/future)

Scopes: membership.write

Parameters (1)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/memberships/{id}/freeze

Freeze with dates (within plan limits)

Scopes: membership.freeze

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/memberships/{id}/unfreezePLANNED

Resume early

Scopes: membership.freeze

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/memberships/{id}/cancel

Cancel (self-service allowed; effective date + exit survey)

Scopes: membership.cancel

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/memberships/{id}/reactivatePLANNED

Reactivate a cancelled membership

Scopes: membership.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/memberships/{id}/transferPLANNED

Transfer to another member

Scopes: membership.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Pro shop

get/v1/productsPLANNED

Products

Scopes: pos.sell

post/v1/productsPLANNED

Create a product

Scopes: inventory.write

Request body
{
 "type": "object"
}
post/v1/products/{id}/inventory/adjustPLANNED

Adjust inventory

Scopes: inventory.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/salesPLANNED

Record a sale

Scopes: pos.sell

Parameters (1)
  • idempotencyKey
Request body
{
 "type": "object"
}
post/v1/sales/{id}/refundPLANNED

Refund a sale

Scopes: pos.refund

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Communication

post/v1/email/send

Send an email (template or inline, merge tokens)

Scopes: comms.send

Request body
{
 "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"
   ]
  }
 }
}
post/v1/sms/send

Send an SMS. Minors require cc_parent (MAAPP two-deep).

Scopes: comms.send

Request body
{
 "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"
  }
 }
}
post/v1/push/send

Send a push notification

Scopes: comms.send

Request body
{
 "type": "object"
}
get/v1/email-templates

Email templates

Scopes: comms.send

post/v1/email-templates

Create a template

Scopes: comms.send

Request body
{
 "type": "object"
}
patch/v1/email-templates/{id}

Update a template

Scopes: comms.send

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/email-templates/{id}

Delete a template

Scopes: comms.send

Parameters (1)
  • id (path)
post/v1/email-templates/{id}/preview

Render with sample tokens

Scopes: comms.send

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/sms-templates

SMS templates

Scopes: comms.send

post/v1/sms-templates

Create an SMS template

Scopes: comms.send

Request body
{
 "type": "object"
}
patch/v1/sms-templates/{id}

Update

Scopes: comms.send

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/sms-templates/{id}

Delete

Scopes: comms.send

Parameters (1)
  • id (path)
get/v1/broadcasts

Broadcasts

Scopes: comms.broadcast

Parameters (2)
  • cursor
  • limit
post/v1/broadcasts

Send or schedule a broadcast to a segment (preview=true for samples)

Scopes: comms.broadcast

Request body
{
 "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"
  }
 }
}
get/v1/broadcasts/{id}

Broadcast with delivery breakdown

Scopes: comms.broadcast

Parameters (1)
  • id (path)
get/v1/conversations

SMS inbox (unread first)

Scopes: comms.send

Parameters (3)
  • assigned_staff_id (query)
  • unread (query)
  • search (query)
get/v1/conversations/{id}

Conversation with messages

Scopes: comms.send

Parameters (1)
  • id (path)
post/v1/conversations/{id}/messages

Reply

Scopes: comms.send

Parameters (1)
  • id (path)
Request body
{
 "type": "object",
 "required": [
  "body"
 ],
 "properties": {
  "body": {
   "type": "string"
  },
  "cc_parent": {
   "type": "boolean"
  }
 }
}
post/v1/conversations/{id}/assign

Assign to staff

Scopes: conversation.assign

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/conversations/{id}/read

Mark read

Scopes: comms.send

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Workflows

get/v1/workflows

Automations

Scopes: settings.read

post/v1/workflows

Create an automation with steps

Scopes: settings.write

Request body
{
 "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"
     }
    }
   }
  }
 }
}
patch/v1/workflows/{id}

Update (replacing steps bumps version)

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "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"
     }
    }
   }
  }
 }
}
delete/v1/workflows/{id}

Delete

Scopes: settings.write

Parameters (1)
  • id (path)
post/v1/workflows/{id}/activate

Activate

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/workflows/{id}/pause

Pause

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/workflows/{id}/runs

Runs

Scopes: settings.read

Parameters (1)
  • id (path)
post/v1/workflows/{id}/test-run

Run immediately for a member/lead

Scopes: settings.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/workflows/triggers

Trigger catalog

Scopes: settings.read

get/v1/workflows/step-types

Step catalog

Scopes: settings.read

post/v1/workflows/install-defaults

Install default automations

Scopes: settings.write

Request body
{
 "type": "object"
}

Staff

get/v1/staff

Staff list

Scopes: staff.read

Parameters (2)
  • cursor
  • limit
post/v1/staff

Invite staff (emails a set-password link)

Scopes: staff.write

Request body
{
 "type": "object"
}
get/v1/staff/me

Current staff profile

get/v1/staff/{id}

Staff detail with credentials

Scopes: staff.read

Parameters (1)
  • id (path)
patch/v1/staff/{id}

Update (roles require role.assign)

Scopes: staff.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/staff/{id}

Terminate

Scopes: staff.write

Parameters (1)
  • id (path)
get/v1/staff/{id}/credentialsPLANNED

Coach credentials

Scopes: staff.read

Parameters (1)
  • id (path)
post/v1/staff/{id}/credentialsPLANNED

Add a credential (JSON or multipart)

Scopes: staff.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/roles

Roles (system + custom)

Scopes: staff.read

post/v1/roles

Create a custom role

Scopes: role.assign

Request body
{
 "type": "object"
}
get/v1/roles/permissions

Capability matrix

Scopes: staff.read

get/v1/time-entries

Time clock entries

post/v1/time-entries/clock-in

Clock in

Request body
{
 "type": "object"
}
post/v1/time-entries/clock-out

Clock out

Request body
{
 "type": "object"
}
get/v1/payroll

Payroll for a period (format=csv for Gusto/ADP)

Scopes: staff.read, report.read

Parameters (3)
  • period_start (query)
  • period_end (query)
  • format (query)
get/v1/payroll/rules

Payroll rules

Scopes: staff.read

post/v1/payroll/rules

Create a payroll rule

Scopes: staff.write

Request body
{
 "type": "object"
}

Events

post/v1/eventsPLANNED

Create an event (seminar, camp, tournament…)

Scopes: event.write

Request body
{
 "type": "object"
}
post/v1/events/{id}/registrationsPLANNED

Register

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/competitionsPLANNED

Create a competition

Scopes: competition.write

Request body
{
 "type": "object"
}
post/v1/competitions/{id}/entriesPLANNED

Add an entry with matches

Scopes: competition.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}

Reports

get/v1/reports

Report catalog

Scopes: report.read

get/v1/reports/{key}

Run a canned report (format=json|csv)

Scopes: report.read

Parameters (8)
  • key (path)
  • format (query)
  • from (query)
  • to (query)
  • group_by (query)
  • bucket (query)
  • range (query)
  • window (query)
get/v1/reports/needs-you

Dashboard attention aggregator

Scopes: report.read

post/v1/reports/scheduled

Schedule a report email

Scopes: report.export

Request body
{
 "type": "object"
}
get/v1/reports/scheduled

Scheduled reports

Scopes: report.read

delete/v1/reports/scheduled/{id}

Delete a scheduled report

Scopes: report.export

Parameters (1)
  • id (path)

Webhooks

get/v1/webhooks

Subscriptions

Scopes: webhook.write

post/v1/webhooks

Subscribe (signing secret returned once)

Scopes: webhook.write

Request body
{
 "type": "object",
 "required": [
  "url",
  "events"
 ],
 "properties": {
  "url": {
   "type": "string"
  },
  "events": {
   "type": "array",
   "items": {
    "type": "string"
   }
  },
  "description": {
   "type": "string"
  }
 }
}
delete/v1/webhooks/{id}

Unsubscribe

Scopes: webhook.write

Parameters (1)
  • id (path)
post/v1/webhooks/{id}/rotate-secret

Rotate signing secret

Scopes: webhook.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/webhooks/deliveries

Delivery log

Scopes: webhook.write

Parameters (2)
  • webhook_id (query)
  • status (query)
post/v1/webhooks/deliveries/{id}/replay

Replay a delivery

Scopes: webhook.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/webhooks/eventsPUBLIC

Event catalog

post/v1/webhooks/test

Send a ping

Scopes: webhook.write

Request body
{
 "type": "object"
}

API keys

get/v1/api-keys

API keys (masked)

Scopes: api_key.write

post/v1/api-keys

Create (raw key returned once)

Scopes: api_key.write

Request body
{
 "type": "object"
}
delete/v1/api-keys/{id}

Revoke

Scopes: api_key.write

Parameters (1)
  • id (path)
post/v1/api-keys/{id}/rotate

Rotate

Scopes: api_key.write

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
get/v1/oauth-clients

OAuth clients

Scopes: api_key.write

post/v1/oauth-clients

Create an OAuth client (secret returned once)

Scopes: api_key.write

Request body
{
 "type": "object"
}
delete/v1/oauth-clients/{id}

Revoke

Scopes: api_key.write

Parameters (1)
  • id (path)

Integrations

get/v1/integrations

Integration catalog with connection status

Scopes: settings.read

post/v1/integrations/{provider}/connect

Connect (secrets encrypted at rest)

Scopes: settings.write

Parameters (1)
  • provider (path)
Request body
{
 "type": "object"
}
post/v1/integrations/{provider}/disconnect

Disconnect

Scopes: settings.write

Parameters (1)
  • provider (path)
Request body
{
 "type": "object"
}
get/v1/integrations/zapier/triggers

Zapier trigger list

post/v1/integrations/zapier/subscribe

Zapier REST hook subscribe

Scopes: webhook.write

Request body
{
 "type": "object"
}
delete/v1/integrations/zapier/subscribe

Zapier REST hook unsubscribe

Scopes: webhook.write

Platform

get/v1/audit-log

Append-only audit log

Scopes: settings.read

get/v1/notifications

Staff notifications

post/v1/notifications/{id}/read

Mark read

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
post/v1/notifications/read-all

Mark all read

Request body
{
 "type": "object"
}
get/v1/tasks

Staff tasks

post/v1/tasks

Create a task

Request body
{
 "type": "object"
}
patch/v1/tasks/{id}

Update a task

Parameters (1)
  • id (path)
Request body
{
 "type": "object"
}
delete/v1/tasks/{id}

Delete a task

Parameters (1)
  • id (path)
get/v1/openapi.jsonPUBLIC

This document

Data portability

post/v1/data/export

Queue a full export (tar.gz). Free. Always.

Scopes: member.export

Request body
{
 "type": "object"
}
get/v1/data/exports/{id}PLANNED

Export status + download URL

Scopes: member.export

Parameters (1)
  • id (path)
post/v1/data/erase

GDPR right-to-erasure (billing retention exceptions)

Scopes: member.delete

Request body
{
 "type": "object"
}

Public

get/public/v1/{slug}/schedule.jsonPUBLIC

Public schedule (CORS open, cacheable)

Parameters (1)
  • slug (path)
get/public/v1/{slug}/schedule.icsPUBLIC

Public schedule iCal

Parameters (1)
  • slug (path)
get/public/v1/{slug}/locationsPUBLICPLANNED

Public locations

Parameters (1)
  • slug (path)
post/public/v1/{slug}/leadsPUBLIC

Public lead form (rate limited, captcha)

Parameters (1)
  • slug (path)
Request body
{
 "type": "object"
}
get/widgets/schedule.jsPUBLICPLANNED

Embeddable schedule widget

Webhook events

HTTPS POST, JSON body {id, type, created_at, data}, header X-MMA-Signature: t=<ts>,v1=<hmac_sha256>. Retries with exponential backoff (1m, 5m, 30m, 1h, 6h, 24h), then dead-letter with replay from Settings → API & webhooks.

member.createdA member profile was created
member.updatedA member profile changed
member.archivedA member was soft-deleted
lead.createdA lead was captured
lead.convertedA lead became a member
lead.lostA lead was marked lost
membership.startedA membership became active
membership.frozenA membership was frozen
membership.unfrozenA membership resumed
membership.cancelledA membership was cancelled
membership.expiredA membership reached its end date
invoice.createdAn invoice was generated
invoice.paidAn invoice was paid in full
invoice.payment_failedA charge against an invoice failed
invoice.refundedAn invoice was refunded
payment.succeededA payment succeeded
payment.failedA payment failed
payment.refundedA payment was refunded
attendance.recordedA check-in was recorded
attendance.late_cancelA reservation was cancelled inside the late window
attendance.no_showA reserved member did not check in
reservation.createdA class reservation was made
reservation.cancelledA reservation was cancelled
reservation.waitlist_promotedA waitlisted member got a spot
promotion.grantedA rank or stripe was awarded
promotion.voidedA rank award was voided
eligibility.changedA member's promotion eligibility changed
belt_test.createdA belt test event was scheduled
belt_test.finalizedA belt test event was finalized
class_instance.cancelledA class was cancelled
class_instance.capacity_changedA class capacity changed
event.registeredSomeone registered for an event
event.cancelledAn event was cancelled
sale.completedA pro-shop sale completed
sale.refundedA pro-shop sale was refunded
waiver.signedA waiver was signed
waiver.version_publishedA new waiver version was published
workflow.run_startedAn automation run started
workflow.run_completedAn automation run completed
workflow.run_erroredAn automation run errored
sms.receivedAn inbound SMS arrived
conversation.assignedA conversation was assigned to staff
coach_credential.expiring_soonA coach credential expires within 30 days
coach_credential.expiredA coach credential expired
data.export.readyA data export is ready to download

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"
  }
 }
}