PerfectGym Next Open API

API reference

PerfectGym Next API

Appointment, bookable appointment and slots operations
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
Manage membership contracts
Membership operations
Get studio information
Get trial offers information

Download OpenAPI description

openapi.json

openapi.yaml

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

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

Get employees

Request

Required Scopes: EMPLOYEE_READ

Returns employees for studio defined by used x-api-key.

Query

offsetstring

Offset from last request

Default "0"

sliceSizeinteger(int32)[ 10 .. 100 ]

Desired size of data chunk

Default 50

curl -i -X GET \
  'https://open-api-demo.open-api.perfectgym.com/v1/employees?offset=0&sliceSize=50' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

resultArray of objects(Employee)required

List of employees

result[].idinteger(int64)required

Unique ID of the employee

Example: 1001

result[].firstNamestringrequired

The first name of the employee

Example: "Peter"

result[].lastNamestringrequired

The last name of the employee

Example: "Parker"

result[].employeeImageUrlstring

The URL of the employee image

Example: "https://example.com/image.jpg"

result[].genderstringrequired

Gender of the customer

Enum Value	Description
MALE	Male gender of the customer
FEMALE	Female gender of the customer
UNISEX	Unisex gender of the customer

Example: "MALE"

result[].dateOfBirthstring(date)

The date of birth of the employee

Example: "1990-01-01"

result[].employeeNumberstring

The employee number

Example: "123456a"

result[].employeeInitialsstringrequired

The initials of the employee

Example: "P.P."

result[].publicNamestring

The public name of the employee

Example: "Peter Parker"

result[].businessRolestring

The business role of an employee

Enum Value	Description
STUDIO_MANAGER	The employee is the manager of the studio.
SERVICE_EMPLOYEE	The employee is a service employee of the studio.
ADMINISTRATION_OR_FINANCE	The employee is participating in administration or finance of the studio.
STUDIO_OWNER	The employee is the owner of the studio.
MARKETING	The employee is participating in marketing of the studio.
TRAINER	The employee is a trainer of the studio.

Example: "STUDIO_OWNER"

result[].externalRolestring

The external role of the employee

Example: "Trainer"

result[].phone1string

The first phone number of the employee

Example: "+49123456789"

result[].phone2string

The second phone number of the employee

Example: "+49123456789"

result[].emailstring

The email of the employee

Example: "example@example.com"

result[].streetstring

The street of the employee

Example: "Main Street"

result[].houseNumberstring

The house number of the employee

Example: "123a"

result[].zipCodestring

The zip code of the employee

Example: "123-45"

result[].citystring

The city of the employee

Example: "Berlin"

result[].countrystring

The country of the employee

Example: "DE"

result[].employeeCompetencesArray of strings

The competences of the employee

Example: ["Trainer"]

hasNextbooleanrequired

True if there exists next data slice

Example: true

offsetstringrequired

Offset for next query

Example: "1234567890"

Response

application/json

{
  "result": [
    { … }
  ],
  "hasNext": true,
  "offset": "1234567890"
}

Get employee

Request

Required Scopes: EMPLOYEE_READ

Returns employee by id

Path

idinteger(int64)required

The ID of the employee

curl -i -X GET \
  'https://open-api-demo.open-api.perfectgym.com/v1/employees/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

idinteger(int64)required

Unique ID of the employee

Example: 1001

firstNamestringrequired

The first name of the employee

Example: "Peter"

lastNamestringrequired

The last name of the employee

Example: "Parker"

employeeImageUrlstring

The URL of the employee image

Example: "https://example.com/image.jpg"

genderstringrequired

Gender of the customer

Enum Value	Description
MALE	Male gender of the customer
FEMALE	Female gender of the customer
UNISEX	Unisex gender of the customer

Example: "MALE"

dateOfBirthstring(date)

The date of birth of the employee

Example: "1990-01-01"

employeeNumberstring

The employee number

Example: "123456a"

employeeInitialsstringrequired

The initials of the employee

Example: "P.P."

publicNamestring

The public name of the employee

Example: "Peter Parker"

businessRolestring

The business role of an employee

Enum Value	Description
STUDIO_MANAGER	The employee is the manager of the studio.
SERVICE_EMPLOYEE	The employee is a service employee of the studio.
ADMINISTRATION_OR_FINANCE	The employee is participating in administration or finance of the studio.
STUDIO_OWNER	The employee is the owner of the studio.
MARKETING	The employee is participating in marketing of the studio.
TRAINER	The employee is a trainer of the studio.

Example: "STUDIO_OWNER"

externalRolestring

The external role of the employee

Example: "Trainer"

phone1string

The first phone number of the employee

Example: "+49123456789"

phone2string

The second phone number of the employee

Example: "+49123456789"

emailstring

The email of the employee

Example: "example@example.com"

streetstring

The street of the employee

Example: "Main Street"

houseNumberstring

The house number of the employee

Example: "123a"

zipCodestring

The zip code of the employee

Example: "123-45"

citystring

The city of the employee

Example: "Berlin"

countrystring

The country of the employee

Example: "DE"

employeeCompetencesArray of strings

The competences of the employee

Example: ["Trainer"]

Response

application/json

{
  "id": 1001,
  "firstName": "Peter",
  "lastName": "Parker",
  "employeeImageUrl": "https://example.com/image.jpg",
  "gender": "MALE",
  "dateOfBirth": "1990-01-01",
  "employeeNumber": "123456a",
  "employeeInitials": "P.P.",
  "publicName": "Peter Parker",
  "businessRole": "STUDIO_OWNER",
  "externalRole": "Trainer",
  "phone1": "+49123456789",
  "phone2": "+49123456789",
  "email": "example@example.com",
  "street": "Main Street",
  "houseNumber": "123a",
  "zipCode": "123-45",
  "city": "Berlin",
  "country": "DE",
  "employeeCompetences": [
    "Trainer"
  ]
}

Finance

Debt collection operations

Operations

Membership Self-service

Manage membership contracts

Operations

Memberships

Membership operations

Operations

Studios

Get studio information

Operations

Trial Offers

Get trial offers information

Operations

PerfectGym Next API

Appointments

Classes

Cross Studio

Customers

Customers Account

Customers Communication

Customers Self-service

Devices

Employees

Get employees

Request

Responses

Rate this section

Get employee

Request

Responses

Rate this section

Finance

Membership Self-service

Memberships

Studios

Trial Offers