Skip to content
PerfectGym Next Open API
/
API reference
/
/
Returns document for a cu...

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

Upload new document to a customer

Request

Required Scopes: CUSTOMER_DOCUMENT_WRITE

Returns the newly uploaded document information

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Query
descriptionstring

Document description

Example: description=Member contract
Bodymultipart/form-data
filestring(binary)required

Upload file with correct extension.

curl -i -X POST \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/documents?description=Member+contract' \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -F file=string

Responses

OK

Bodyapplication/json
idinteger(int64)

Unique ID of the document

Example: 1241246660
Response
application/json
{
  "id": 1241246660
}

Returns document for a customer

Request

Required Scopes: CUSTOMER_DOCUMENT_READ

Returns document for a customer

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

idinteger(int64)required

Unique ID of the document

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

Responses

OK

Bodyapplication/json
urlstring

URL to download document valid for 15 minutes

idinteger(int64)

Unique ID of the document

Example: 1241246660
fileNamestring

Name of the document

descriptionstring

Description of the document

createdDateTimestring(date-time)

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

Example: "2022-06-15T23:59:59.123+02:00"
Response
application/json
{
  "url": "string",
  "id": 1241246660,
  "fileName": "string",
  "description": "string",
  "createdDateTime": "2022-06-15T23:59:59.123+02:00"
}

Update customer profile image

Request

Required Scopes: CUSTOMER_WRITE

Updates customer profile image. The image will be rescaled(1200x1200) and converted to mime type image/jpeg.

Security
ApiKeyAuth
Path
customerIdinteger(int64)required

Unique ID of the customer

Bodymultipart/form-data
imagestring(binary)required

Upload image with correct extension. Supported mime types: image/jpeg, image/png

curl -i -X PUT \
  'https://open-api-demo.open-api.perfectgym.com/v1/customers/{customerId}/images' \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -F image=string

Responses

OK

Bodyapplication/json
imageUrlstring

Url with an image to download. It will expire after 15 minutes

Example: "https://example.com"
Response
application/json
{
  "imageUrl": "https://example.com"
}

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