Skip to content
PerfectGym Next Open API
/
/Devices

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
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

Get devices

Request

Required Scopes: DEVICE_READ

Returns devices for a studio

Security
ApiKeyAuth
curl -i -X GET \
  https://open-api-demo.open-api.perfectgym.com/v1/devices \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)

Device id

Example: 26
namestring

Device name

Example: "Turnstile (left)"
activebooleanrequired

Device state. If the value is false then the device is inactive and must be activated before use

Example: false
modelstring

Device model

Enum"GENERIC_VENDING_READER""GENERIC_CARD_READER""GENERIC_TIME_READER"
Example: "GENERIC_CARD_READER"
]
Response
application/json
[
  {
    "id": 26,
    "name": "Turnstile (left)",
    "active": false,
    "model": "GENERIC_CARD_READER"
  }
]

Activate device

Request

Required Scopes: DEVICE_WRITE

Activates device and returns token

Security
ApiKeyAuth
Path
deviceIdinteger(int64)required
curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/devices/{deviceId}/activate' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idinteger(int64)

Device id

Example: 26
accessTokenstring

Device token for further communication

Example: "53cda15a-5652-4f62-9b97-508f870ff40b"
Response
application/json
{
  "id": 26,
  "accessToken": "53cda15a-5652-4f62-9b97-508f870ff40b"
}

Employees

Employee operations

Operations

Finance

Debt collection operations

Operations

Leads

Leads operations

Operations

Membership Self-service

Manage membership contracts

Operations

Memberships

Membership operations

Operations

Payments

Payment operations

Operations

Studios

Get studio information

Operations

Trial Offers

Get trial offers information

Operations