Skip to content
PerfectGym Next Open API
/
API reference
/
/
Delete customer's access...

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

Update customer's access medium

Request

Required Scopes: CUSTOMER_ACCESS_MEDIUM_WRITE

Updates the customer's access medium. Only previously created mediums may be updated.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

accessMediumIdinteger(int64)required

Unique ID of the access medium

Bodyapplication/jsonrequired
valuestring

Unique identifier for the access medium

curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/access-mediums/{accessMediumId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "value": "string"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)

Unique identifier for the access medium

Example: 1234567890
typestring

Represents a type of access medium

Enum ValueDescription
PIN

Personal identification number

BARCODE

Barcode content

WALLET_PASS

Wallet pass identifier

CARD_NUMBER

Card number

Example: "CARD_NUMBER"
valuestring

Unique identifier for the access medium

Response
application/json
{
  "id": 1234567890,
  "type": "CARD_NUMBER",
  "value": "string"
}

Delete customer's access medium

Request

Required Scopes: CUSTOMER_ACCESS_MEDIUM_WRITE

Deletes the customer's access medium. Only previously created mediums may be deleted.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

accessMediumIdinteger(int64)required

Unique ID of the access medium

curl -i -X DELETE \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/access-mediums/{accessMediumId}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Response
No content

Returns all documents for a customer

Request

Required Scopes: CUSTOMER_DOCUMENT_READ

Returns all documents for a customer

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Query
offsetstring

Offset from last request

Default "0"
sliceSizeinteger(int32)[ 1 .. 50 ]

Desired size of data chunk

Default 10
curl -i -X GET \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/documents?offset=0&sliceSize=10' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(CustomerDocument)required

List of customer documents

result[].​urlstring

URL to download document valid for 15 minutes

result[].​idinteger(int64)

Unique ID of the document

Example: 1241246660
result[].​fileNamestring

Name of the document

result[].​descriptionstring

Description of the document

result[].​createdDateTimestring(date-time)

Customer's document creation date time in ISO-8601 format

Example: "2022-06-15T23:59:59.123+02:00"
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"
}

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