Skip to content
PerfectGym Next Open API
/
API reference
/
/
Create a manual checkin f...

PerfectGym Next API (1.17.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
  • 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

Replace legal representative

Request

Required Scopes: CUSTOMER_WRITE

Adds or replaces a customer's legal representative.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/jsonrequired
typestringrequired

Type of the legal representative

Enum ValueDescription
EXISTING_CUSTOMER

Links an existing customer as legal representative

EXTERNAL_PERSON

Creates or updates an external person as legal representative

Example: "EXTERNAL_PERSON"
personobject(LegalRepresentativePerson)

External person data used when type is EXTERNAL_PERSON

customerIdinteger(int64)

Customer id used when type is EXISTING_CUSTOMER

Example: 98765
singleParentboolean

Whether the provided legal representative is the only legal guardian

Example: true
addressToLiablePersonboolean

Whether communication and billing should be sent to the legal representative

Example: false
legalRepresentativeSignatureobject(Signature)

The first legal representative signature SVG for the contract document

Example: {"base64SvgSignature":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciLz4="}
legalRepresentativeSignatureSecondPersonobject(Signature)

The second legal representative signature SVG for the contract document

Example: {"base64SvgSignature":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciLz4="}
curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/legal-representative' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "EXTERNAL_PERSON",
    "person": {
      "firstName": "Erika",
      "secondFirstName": "Maria",
      "lastName": "Mustermann",
      "secondLastName": "Meyer",
      "dateOfBirth": "1985-08-24",
      "placeOfBirth": "Hamburg",
      "countryOfBirth": "DE",
      "gender": "MALE",
      "email": "legal.rep@example.com",
      "phoneNumberPrivate": "+44123456789",
      "phoneNumberMobile": "+44987654321",
      "street": "Raboisen Street",
      "houseNumber": "3-4",
      "additionalAddressInformation": "2nd floor",
      "city": "Hamburg",
      "zipCode": "220-99",
      "countryCode": "DE"
    },
    "customerId": 98765,
    "singleParent": true,
    "addressToLiablePerson": false,
    "legalRepresentativeSignature": {
      "base64SvgSignature": "string"
    },
    "legalRepresentativeSignatureSecondPerson": {
      "base64SvgSignature": "string"
    }
  }'

Responses

OK

Response
No content

Create a manual checkin for a customer studio

Request

Required Scopes: CHECKIN_WRITE

Create a manual checkin for a customer in studio.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/json
checkInDateTimestring(date-time)

Check in time of the studio visit in ISO-8601

Example: "2023-12-03T10:15:30+01:00"
curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/checkin' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "checkInDateTime": "2023-12-03T10:15:30+01:00"
  }'

Responses

OK

Response
No content

Create a manual checkout for a customer in studio

Request

Required Scopes: CHECKIN_WRITE

Create a manual checkout for a customer in studio.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/json
checkOutDateTimestring(date-time)

Check out time of the studio visit in ISO-8601 format

Example: "2023-12-03T10:16:30+01:00"
curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/checkout' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "checkOutDateTime": "2023-12-03T10:16:30+01:00"
  }'

Responses

OK

Response
No content

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