Skip to content

PerfectGym Next API (1.31.0)

  • 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
  • Retrieve customer transaction details
  • Get device information
  • Employee operations
  • Debt collection operations
  • Leads operations
  • Get member lists
  • Manage membership contracts
  • Membership operations
  • Online offer 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
Operations

Cross Studio

Cross studio operations

Operations

Customers

Get customers and contracts

Operations

Request

Required Scopes: CUSTOMER_DOCUMENT_WRITE

Deletes a customer document. The document ID is the numeric document ID and differs from the UUID used in webhook events.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

documentIdinteger(int64)required

Numeric ID of the document

curl -i -X DELETE \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/documents/{documentId}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Document deleted successfully.

Response
No content

Create a manual checkin for a customer studio

Request

Required Scopes: CHECKIN_WRITE

Create a manual checkin for a customer in studio.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/json
checkInDateTimestring(date-time)

Check in time of the studio visit in ISO-8601

Example: "2023-12-03T10:15:30+01:00"
curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/checkin' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "checkInDateTime": "2023-12-03T10:15:30+01:00"
  }'

Responses

OK

Response
No content

Create a manual checkout for a customer in studio

Request

Required Scopes: CHECKIN_WRITE

Create a manual checkout for a customer in studio.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/json
checkOutDateTimestring(date-time)

Check out time of the studio visit in ISO-8601 format

Example: "2023-12-03T10:16:30+01:00"
curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/checkout' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "checkOutDateTime": "2023-12-03T10:16:30+01:00"
  }'

Responses

OK

Response
No content

Customers Account

Retrieve customer accounting details

Operations

Customers Communication

Retrieve customer communication details

Operations
Operations

Customers Transactions

Retrieve customer transaction details

Operations
Operations
Operations
Operations
Operations
Operations

Membership Self-service

Manage membership contracts

Operations
Operations

Online offers

Online offer operations

Operations
Operations
Operations

Trial Offers

Get trial offers information

Operations