Skip to content
PerfectGym Next Open API
/
API reference
/
/
Sets additional informati...

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

Get additional information fields

Request

Required Scopes: ADDITIONAL_INFORMATION_READ

Returns additional information fields available for assignment to customers.

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)required

The unique ID of the additional information field

Example: 1234567890
namestringrequired

The name of the additional information field

Example: "Membership Type"
typestringrequired

The type of an additional information field. This defines how the field is used and what kind of data it can hold.

Enum ValueDescription
DATE

This field holds a date value, used for storing dates.

NUMERIC

This field holds a numeric value, used for storing numbers.

TEXT

This field holds a text value, used for storing free-form text input.

LIST

This field holds a list of items, allowing selection from predefined options.

BOOLEAN

This field holds a boolean value, typically used for yes/no questions.

Example: "BOOLEAN"
abbreviationstring

The abbreviation of the additional information field

Example: "MT"
listItemsArray of objects(AdditionalInformationListItem)

A list of list items. This is only used if the field type is a list.

]
Response
application/json
[
  {
    "id": 1234567890,
    "name": "Membership Type",
    "type": "BOOLEAN",
    "abbreviation": "MT",
    "listItems": [ … ]
  }
]

Sets additional information field assignments

Request

Required Scopes: ADDITIONAL_INFORMATION_WRITE

Sets additional information field assignments for a customer. We overwrite existing values, so you need to provide all field assignments that you want to set. If you want to remove a field assignment, don't add it.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodyapplication/jsonrequiredArray [
additionalInformationFieldIdinteger(int64)required

The unique ID of the additional information field

Example: 1234567890
valuestringrequired

The value of the additional information field assignment. For list fields this is the id of the selected item, for text fields this is the text value, for numeric fields must be positive or negative integers, for date fields this is the date in ISO-8601 format, and for boolean fields this is 'true' or 'false'.

namestring

The name of the additional information field

Example: "Membership Type"
]
curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/additional-information-field-assignments' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[
    {
      "additionalInformationFieldId": 1234567890,
      "value": "string",
      "name": "Membership Type"
    }
  ]'

Responses

OK

Bodyapplication/jsonArray [
additionalInformationFieldIdinteger(int64)required

The unique ID of the additional information field

Example: 1234567890
valuestringrequired

The value of the additional information field assignment. For list fields this is the id of the selected item, for text fields this is the text value, for numeric fields must be positive or negative integers, for date fields this is the date in ISO-8601 format, and for boolean fields this is 'true' or 'false'.

namestring

The name of the additional information field

Example: "Membership Type"
]
Response
application/json
[
  {
    "additionalInformationFieldId": 1234567890,
    "value": "string",
    "name": "Membership Type"
  }
]

Switch studio

Request

Required Scopes: CUSTOMER_WRITE

Switches the studio of the given customer to the specified target studio. The API key of the customer's source studio must be used for this request.

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

The ID of the studio to be switched to

Example: 123456789
switchDatestring(date)required

Date of the switch. The date must be the current date or in the past

Example: "2024-01-01"
descriptionstring

A description of the studio switch that will be stored in the customer history

curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/switch-studio' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "targetStudioId": 123456789,
    "switchDate": "2024-01-01",
    "description": "string"
  }'

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