Skip to content

PerfectGym Next API (1.20.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
  • 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_PRIVACY_WRITE

Archives customer by customerId.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

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

Responses

OK

Response
No content

Request

Required Scopes: CUSTOMER_PRIVACY_WRITE

Anonymises archived customer by customerId.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

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

Responses

OK

Response
No content

Request

Required Scopes: FAMILY_CONTRACT_ASSIGNMENT_WRITE

Joins a customer to a family contract.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required
Bodyapplication/jsonrequired
codestringrequired

The unique code which is necessary for joining a family contract

Example: "DSV12-578945"
relationshipTypestring(FamilyContractRelationshipType)required

Relationship type between a customer and a family contract

Enum ValueDescription
PARTNER

The customer is a partner

FRIEND

The customer is a friend

PARENT

The customer is a parent

SPOUSE

The customer is a spouse

CHILD

The customer is a child

Example: "PARTNER"
curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/join-family-contract' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "code": "DSV12-578945",
    "relationshipType": "PARTNER"
  }'

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