Skip to content
Magicline Open API
/
API reference
/
/
Upload new document to a...

Magicline API (1.13.2)

  • 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
  • Get device information
  • Employee operations
  • Debt collection operations
  • Leads operations
  • 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.magicline.com/

Mock server

https://redocly.sportalliance.com/_mock/apis/magicline/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

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.magicline.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 items

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

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"
}

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.magicline.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.magicline.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

Response
application/json
{
  "url": "string",
  "id": 1241246660,
  "fileName": "string",
  "description": "string"
}

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

Finance

Debt collection operations

Operations

Leads

Leads operations

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