Skip to content
PerfectGym Next Open API
/
API reference
/
/
Get studio's contract can...

PerfectGym Next API (1.10.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
  • 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
openapi.json
openapi.yaml
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

Classes

Class and slots operations

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

Customers Self-service

Operations

Devices

Get device information

Operations

Employees

Employee operations

Operations

Finance

Debt collection operations

Operations

Leads

Leads operations

Operations

Membership Self-service

Manage membership contracts

Operations

Create contract cancelation amendment

Request

Required Scopes: MEMBERSHIP_SELF_SERVICE_WRITE

Creates contract cancelation amendment for specified contract id

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/jsonrequired
cancelationDatestring(date)required

Date the contract should be canceled to

Example: "2023-01-25"
cancelationReasonIdinteger(int64)required

Id of the reason why the contract is canceled

Example: 1234
contractIdinteger(int64)required

Id of the contract

Example: 1000
curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/memberships/{customerId}/self-service/ordinary-contract-cancelation' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "cancelationDate": "2023-01-25",
    "cancelationReasonId": 1234,
    "contractId": 1000
  }'

Responses

OK

Bodyapplication/json
successstring
Response
application/json
{
  "success": "string"
}

Get studio's contract cancelation reason data

Request

Required Scopes: MEMBERSHIP_SELF_SERVICE_READ

Get available contract cancelation reasons for the studio

Security
ApiKeyAuth
curl -i -X GET \
  https://open-api-demo.open-api.perfectgym.com/v1/memberships/self-service/contract-cancelation-reasons \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
cancelationReasonIdinteger(int64)required

Id of the contract cancelation reason

Example: 1000
cancelationReasonNamestringrequired

Name of the contract cancelation reason

Example: "Officially ordered studio closure"
]
Response
application/json
[
  {
    "cancelationReasonId": 1000,
    "cancelationReasonName": "Officially ordered studio closure"
  }
]

withdraw cancelation of contract

Request

Required Scopes: MEMBERSHIP_SELF_SERVICE_WRITE

Withdraws contract cancelation amendment or reverts cancelation for specific contract id

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

contractIdinteger(int64)required

Unique ID of the contract

curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/memberships/{customerId}/self-service/withdraw-ordinary-contract-cancelation/{contractId}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
successstring
Response
application/json
{
  "success": "string"
}

Memberships

Membership operations

Operations

Payments

Payment operations

Operations

Studios

Get studio information

Operations

Trial Offers

Get trial offers information

Operations