Skip to content
PerfectGym Next Open API
/
API reference
/
/
Set customer's access res...

PerfectGym Next API (1.13.2)

  • 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
  • Online offer 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

Update customer profile image

Request

Required Scopes: CUSTOMER_WRITE

Updates customer profile image. The image will be rescaled(1200x1200) and converted to mime type image/jpeg.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodymultipart/form-data
imagestring(binary)required

Upload image with correct extension. Supported mime types: image/jpeg, image/png

curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/images' \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -F image=string

Responses

OK

Bodyapplication/json
imageUrlstring

Url with an image to download. It will expire after 15 minutes

Example: "https://example.com"
Response
application/json
{
  "imageUrl": "https://example.com"
}

Set customer's access restriction

Request

Required Scopes: CUSTOMER_ACCESS_RESTRICTION_WRITE

Creates or updates access restriction for the customer. If the customer already has an access restriction, it will be updated with the provided data. Only previously created restrictions may be updated. If no such restriction exists, it will be created. It is necessary to provide either both startDate and endDate or neither of them.

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

Reason for the restriction

Example: "Destroyed equipment"
startDatestring(date)

Start date of the restriction

Example: "2024-01-01"
endDatestring(date)

End date of the restriction

Example: "2024-06-30"
curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/access-restrictions' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "reason": "Destroyed equipment",
    "startDate": "2024-01-01",
    "endDate": "2024-06-30"
  }'

Responses

OK

Bodyapplication/json
reasonstringrequired

Reason for the restriction

Example: "Destroyed equipment"
startDatestring(date)

Start date of the restriction

Example: "2024-01-01"
endDatestring(date)

End date of the restriction

Example: "2024-06-30"
Response
application/json
{
  "reason": "Destroyed equipment",
  "startDate": "2024-01-01",
  "endDate": "2024-06-30"
}

Delete customer's access restriction

Request

Required Scopes: CUSTOMER_ACCESS_RESTRICTION_WRITE

Deletes the customer's access restriction. Only previously created restrictions may be deleted.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required
curl -i -X DELETE \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/access-restrictions' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Response
No content

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

Memberships

Membership operations

Operations

Online offers

Online offer operations

Operations

Payments

Payment operations

Operations

Studios

Get studio information

Operations

Trial Offers

Get trial offers information

Operations