Skip to content
PerfectGym Next Open API
/
API reference
/
/
Get customer's benefits

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

Save weighing results

Request

Required Scopes(any of): CUSTOMER_WRITE, CUSTOMER_WEIGHING_WRITE

Saves weighing details for given customer

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Query
benefitKeystring

Key of the benefit to use

Bodyapplication/jsonrequired
databaseIdinteger(int64)

Database id of the weighing

basalMetabolicRatenumber

Basal metabolic rate

bodyFatMassnumber

Body fat mass in kg

bodyMassIndexnumber

Body mass index in kg/m^2

fatFreeMassnumber

Total fat free mass (aka Lean Body Mass) in kg

percentBodyFatnumber

Body fat in percent

percentSkeletalMuscleMassnumber

Skeletal muscle mass in percent

skeletalMuscleMassnumber

Skeletal muscle mass in kg

totalBodyWaternumber

Total body water in liters

visceralFatLevelinteger(int32)

Visceral fat level (1-9)

weightnumber

Body weight in kg

heightnumber

Body height in cm

bfmLeftArmnumber

Body Fat Mass of the left arm in kg

bfmLeftLegnumber

Body Fat Mass of the left leg in kg

bfmPercentLeftArmnumber

Body Fat Mass of the left arm in percent

bfmPercentLeftLegnumber

Body Fat Mass of the left leg in percent

bfmPercentRightArmnumber

Body Fat Mass of the right arm in percent

bfmPercentRightLegnumber

Body Fat Mass of the right leg in percent

bfmPercentTrunknumber

Body Fat Mass of the trunk in percent

bfmRightArmnumber

Body Fat Mass of the right arm in kg

bfmRightLegnumber

Body Fat Mass of the right leg in kg

bfmTrunknumber

Body Fat Mass of the trunk in kg

ffmLeftArmnumber

Fat Free Mass of the left arm in kg

ffmLeftLegnumber

Fat Free Mass of the left leg in kg

ffmPercentLeftArmnumber

Fat Free Mass of the left arm in percent

ffmPercentLeftLegnumber

Fat Free Mass of the left leg in percent

ffmPercentRightArmnumber

Fat Free Mass of the right arm in percent

ffmPercentRightLegnumber

Fat Free Mass of the right leg in percent

ffmPercentTrunknumber

Fat Free Mass of the trunk in percent

ffmRightArmnumber

Fat Free Mass of the right arm in kg

ffmRightLegnumber

Fat Free Mass of the right leg in kg

ffmTrunknumber

Fat Free Mass of the trunk in kg

rawResultsstringrequired

The raw results. Might be passed back to partner-provided widgets

curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/weighing?benefitKey=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "databaseId": 0,
    "basalMetabolicRate": 0,
    "bodyFatMass": 0,
    "bodyMassIndex": 0,
    "fatFreeMass": 0,
    "percentBodyFat": 0,
    "percentSkeletalMuscleMass": 0,
    "skeletalMuscleMass": 0,
    "totalBodyWater": 0,
    "visceralFatLevel": 0,
    "weight": 0,
    "height": 0,
    "bfmLeftArm": 0,
    "bfmLeftLeg": 0,
    "bfmPercentLeftArm": 0,
    "bfmPercentLeftLeg": 0,
    "bfmPercentRightArm": 0,
    "bfmPercentRightLeg": 0,
    "bfmPercentTrunk": 0,
    "bfmRightArm": 0,
    "bfmRightLeg": 0,
    "bfmTrunk": 0,
    "ffmLeftArm": 0,
    "ffmLeftLeg": 0,
    "ffmPercentLeftArm": 0,
    "ffmPercentLeftLeg": 0,
    "ffmPercentRightArm": 0,
    "ffmPercentRightLeg": 0,
    "ffmPercentTrunk": 0,
    "ffmRightArm": 0,
    "ffmRightLeg": 0,
    "ffmTrunk": 0,
    "rawResults": "string"
  }'

Responses

OK

Bodyapplication/json
databaseIdinteger(int64)

Database id of the weighing

basalMetabolicRatenumber

Basal metabolic rate

bodyFatMassnumber

Body fat mass in kg

bodyMassIndexnumber

Body mass index in kg/m^2

fatFreeMassnumber

Total fat free mass (aka Lean Body Mass) in kg

percentBodyFatnumber

Body fat in percent

percentSkeletalMuscleMassnumber

Skeletal muscle mass in percent

skeletalMuscleMassnumber

Skeletal muscle mass in kg

totalBodyWaternumber

Total body water in liters

visceralFatLevelinteger(int32)

Visceral fat level (1-9)

weightnumber

Body weight in kg

heightnumber

Body height in cm

bfmLeftArmnumber

Body Fat Mass of the left arm in kg

bfmLeftLegnumber

Body Fat Mass of the left leg in kg

bfmPercentLeftArmnumber

Body Fat Mass of the left arm in percent

bfmPercentLeftLegnumber

Body Fat Mass of the left leg in percent

bfmPercentRightArmnumber

Body Fat Mass of the right arm in percent

bfmPercentRightLegnumber

Body Fat Mass of the right leg in percent

bfmPercentTrunknumber

Body Fat Mass of the trunk in percent

bfmRightArmnumber

Body Fat Mass of the right arm in kg

bfmRightLegnumber

Body Fat Mass of the right leg in kg

bfmTrunknumber

Body Fat Mass of the trunk in kg

ffmLeftArmnumber

Fat Free Mass of the left arm in kg

ffmLeftLegnumber

Fat Free Mass of the left leg in kg

ffmPercentLeftArmnumber

Fat Free Mass of the left arm in percent

ffmPercentLeftLegnumber

Fat Free Mass of the left leg in percent

ffmPercentRightArmnumber

Fat Free Mass of the right arm in percent

ffmPercentRightLegnumber

Fat Free Mass of the right leg in percent

ffmPercentTrunknumber

Fat Free Mass of the trunk in percent

ffmRightArmnumber

Fat Free Mass of the right arm in kg

ffmRightLegnumber

Fat Free Mass of the right leg in kg

ffmTrunknumber

Fat Free Mass of the trunk in kg

rawResultsstringrequired

The raw results. Might be passed back to partner-provided widgets

Response
application/json
{
  "databaseId": 0,
  "basalMetabolicRate": 0,
  "bodyFatMass": 0,
  "bodyMassIndex": 0,
  "fatFreeMass": 0,
  "percentBodyFat": 0,
  "percentSkeletalMuscleMass": 0,
  "skeletalMuscleMass": 0,
  "totalBodyWater": 0,
  "visceralFatLevel": 0,
  "weight": 0,
  "height": 0,
  "bfmLeftArm": 0,
  "bfmLeftLeg": 0,
  "bfmPercentLeftArm": 0,
  "bfmPercentLeftLeg": 0,
  "bfmPercentRightArm": 0,
  "bfmPercentRightLeg": 0,
  "bfmPercentTrunk": 0,
  "bfmRightArm": 0,
  "bfmRightLeg": 0,
  "bfmTrunk": 0,
  "ffmLeftArm": 0,
  "ffmLeftLeg": 0,
  "ffmPercentLeftArm": 0,
  "ffmPercentLeftLeg": 0,
  "ffmPercentRightArm": 0,
  "ffmPercentRightLeg": 0,
  "ffmPercentTrunk": 0,
  "ffmRightArm": 0,
  "ffmRightLeg": 0,
  "ffmTrunk": 0,
  "rawResults": "string"
}

Get customer's benefits

Request

Required Scopes(any of): CUSTOMER_BENEFIT_READ, CUSTOMER_READ

Returns all customer's benefits

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Query
keyArray of strings

Benefit keys to validate, when provided, service will check only them

Example: key=FIRST_KEY&key=SECOND_KEY
curl -i -X GET \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/benefits?key=FIRST_KEY%26key%3DSECOND_KEY' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
keystringrequired

Benefit key

Example: "BENEFIT_KEY"
validbooleanrequired

Validation result

Example: false
]
Response
application/json
[
  {
    "key": "BENEFIT_KEY",
    "valid": false
  }
]

Get customer's benefits by

Request

Required Scopes(any of): CUSTOMER_BENEFIT_READ, CUSTOMER_READ

Returns customer's benefits by one of the given parameters: card number, barcode or pin. Exactly one identifier must be provided.

Security
ApiKeyAuth
Query
cardNumberstring

Card number to identify the customer

cardNumberFormatstring(CardNumberFormat)

Defines how card numbers are interpreted

Default "DECIMAL"
Enum"DECIMAL""HEX_MSB""HEX_LSB"
barcodestring

Barcode to identify the customer

pinstring

PIN to identify the customer

keyArray of strings

Benefit keys to validate, when provided, service will check only them

Example: key=FIRST_KEY&key=SECOND_KEY
curl -i -X GET \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/benefits?cardNumber=string&cardNumberFormat=DECIMAL&barcode=string&pin=string&key=FIRST_KEY%26key%3DSECOND_KEY' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
keystringrequired

Benefit key

Example: "BENEFIT_KEY"
validbooleanrequired

Validation result

Example: false
]
Response
application/json
[
  {
    "key": "BENEFIT_KEY",
    "valid": false
  }
]

Customers Account

Retrieve customer accounting details

Operations

Customers Communication

Retrieve customer communication details

Operations

Customers Self-service

Operations

Customers Transactions

Retrieve customer transaction details

Operations

Devices

Get device information

Operations

Employees

Employee operations

Operations

Finance

Debt collection operations

Operations

Leads

Leads operations

Operations

Member Lists

Get member lists

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