Skip to content

PerfectGym Next API (1.11.1)

  • Appointment, bookable appointment and slots operations
  • Redeem checkin vouchers
  • Class and slots operations
  • Cross studio operations
  • Get customers and contracts
  • Retrieve customer accounting details
  • Retrieve customer communication details
  • Get device information
  • Employee operations
  • Debt collection operations
  • Leads operations
  • Manage membership contracts
  • Membership operations
  • Payment operations
  • Get studio information
  • Get trial offers information
Download OpenAPI description
Languages
Servers
Demo tenant

https://open-api-demo.open-api.perfectgym.com/

Mock server

https://redocly.sportalliance.com/_mock/apis/perfectgym/openapi/openapi/

Appointments

Appointment, bookable appointment and slots operations

Operations

Checkin vouchers

Redeem checkin vouchers

Operations

Request

Required Scopes: CHECKIN_VOUCHER_WRITE

Redeem checkin voucher

Security
ApiKeyAuth
Bodyapplication/jsonrequired
voucherCodestringrequired

Voucher code to redeem

Example: "CHVB1-YL29-MYVA"
firstnamestringrequired

First name of the lead customer

Example: "Max"
lastnamestringrequired

Last name of the lead customer

Example: "Mustermann"
emailstringrequired

Email of the lead customer

Example: "example@email.com"
onlineOfferIdinteger(int64)required

Unique ID of the online offer

Example: 1234567890
curl -i -X POST \
  https://open-api-demo.open-api.perfectgym.com/v1/checkin-vouchers/redeem \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "voucherCode": "CHVB1-YL29-MYVA",
    "firstname": "Max",
    "lastname": "Mustermann",
    "email": "example@email.com",
    "onlineOfferId": 1234567890
  }'

Responses

OK

Bodyapplication/json
studioAccessCodestringrequired

Code to checkin to a studio

Example: "PTKXPMUO"
Response
application/json
{ "studioAccessCode": "PTKXPMUO" }
Operations

Cross Studio

Cross studio operations

Operations

Customers

Get customers and contracts

Operations

Customers Account

Retrieve customer accounting details

Operations

Customers Communication

Retrieve customer communication details

Operations
Operations
Operations
Operations
Operations
Operations

Membership Self-service

Manage membership contracts

Operations
Operations
Operations
Operations

Trial Offers

Get trial offers information

Operations