Back to GymMaster Software

GymMaster Member Portal API

Version: v519

Schemes:

Summary

Path Operation Description
/portal/api/v1/booking/classes GET
POST
/portal/api/v1/booking/classes/schedule GET
/portal/api/v1/booking/classes/seats GET
/portal/api/v1/booking/resources GET
/portal/api/v1/booking/servicebookings GET
POST
/portal/api/v1/booking/services GET
/portal/api/v1/companies GET
/portal/api/v1/email/feedback POST
/portal/api/v1/email/resetpassword POST
/portal/api/v1/email/sendemailtemplate POST
/portal/api/v1/login POST
/portal/api/v1/measurements GET
/portal/api/v1/member/cancelbooking POST
/portal/api/v1/member/memberships GET
/portal/api/v1/member/outstandingbalance GET
/portal/api/v1/member/profile GET
POST
/portal/api/v1/member_classbookings GET
/portal/api/v1/member_servicebookings GET
/portal/api/v1/members GET
/portal/api/v1/memberships GET
POST
/portal/api/v1/memberships/cancel GET
POST
/portal/api/v1/memberships/suspend POST
/portal/api/v1/prospect/create POST
/portal/api/v1/signup POST

Paths

GET /portal/api/v1/booking/classes

Retrieves a list of upcoming bookings that the logged in member can book into

api_key

API Key for integration

query string
token

Returned token from login call

query string
date

Date to show the classes of in ISO format (YYYY-MM-DD) - Week displayed will be 7 days from this date

query string
200 OK

Successful response

result: object[]
error: string

POST /portal/api/v1/booking/classes

Book in to a class booking

api_key

API Key for integration

formData string
token

Returned token from login call

formData string
class

ID number of the class

formData integer
seat

Seat number to be booked in on

formData integer
200 OK

Successful response

result: string
bookingid: integer

The ID of the booking created, if successful

error: string

GET /portal/api/v1/booking/classes/schedule

Retrieves a schedule of classes in a given week

api_key

API Key for integration

query string
date

Date to show the schedule of in ISO format (YYYY-MM-DD) - Week displayed will be 7 days from this date

query string
resourceid

Only show classes on this resource

query integer
companyid

Only show classes that are part of this club

query integer
classid

Only show classes with this class type

query integer
staffid

Only show classes with this assigned staff member

query integer
200 OK

Successful response

result: object[]
error: string

GET /portal/api/v1/booking/classes/seats

Retrieves a list of available seats in a given class

api_key

API Key for integration

query string
token

Returned token from login call

query string
bookingid

ID number of the class

query integer
200 OK

Successful response

result: object[]
error: string

GET /portal/api/v1/booking/resources

Get a list of available resources for making a service booking

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: object[]
error: string

GET /portal/api/v1/booking/servicebookings

Get a list of available service bookings using the provided resource, booking type, and benefit

api_key

API Key for integration

query string
token

Returned token from login call

query string
resourceid

The ID number of the resource to use

query integer
bookingtypeid

The ID number of the booking type to use

query integer
benefitid

The ID number of the benefit to use

query integer
200 OK

Successful response

result: object[]
error: string

POST /portal/api/v1/booking/servicebookings

Book a service booking

api_key

API Key for integration

formData string
token

Returned token from login call

formData string
resourceid

The ID number of the resource to book on

formData integer
bookingtypeid

The ID number of the booking type to book

formData integer
benefitid

The ID number of the benefit to book with

formData integer
membershipid

The ID number of the membership to book with

formData integer
day

The date of the booking in ISO format (YYYY-MM-DD)

formData string
bookingstart

The start of the booking in format HH:MM:SS

formData string
bookingend

The end of the booking in format HH:MM:SS

formData string
200 OK

Successful response

result: string
error: string

GET /portal/api/v1/booking/services

Get a list of services that can be used booking on a given resource when making a service booking

api_key

API Key for integration

query string
token

Returned token from login call

query string
resourceid

The ID number of the resource to check

query integer
200 OK

Successful response

result: object[]
error: string

GET /portal/api/v1/companies

Get a list of the clubs set up

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: Club
error: string

POST /portal/api/v1/email/feedback

Sends feedback to the facility from a member given their email address

api_key

API Key for integration

formData string
email

Email of the member sending feedback

formData string
message

The feedback being sent

formData string
200 OK

Successful response

result: string
error: string

POST /portal/api/v1/email/resetpassword

Sends a password reset link email to any member with the provided email

api_key

API Key for integration

formData string
email

Member email who needs to reset their password

formData string
200 OK

Successful response

result: string
error: string

POST /portal/api/v1/email/sendemailtemplate

Send an email to a member using a specific GymMaster email template

api_key

API Key for integration

formData string
email

Email of the member to send the email to

formData string
templateid

Unique identifier representing an email template in GymMaster

formData integer
200 OK

Successful response

result: string
error: string

POST /portal/api/v1/login

Login as member to perform actions using member account. Use returned token for any future calls.

api_key

API Key for integration

formData string
email

Member email to log in as

formData string
password

Member password to log in as

formData string
200 OK

Successful response

result: object
token: string
error: string

GET /portal/api/v1/measurements

Retrieves a list of all measurements for a member

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: object[]
error: string

POST /portal/api/v1/member/cancelbooking

Cancel a member booking

api_key

API Key for integration

formData string
token

Returned token from login call

formData string
bookingid

The ID number of the booking to cancel

formData integer
waitlist

1 if the booking is a waitlist booking

formData integer
200 OK

Successful response

result: string
error: string

GET /portal/api/v1/member/memberships

Get a list of member's current memberships

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: MemberMembership
error: string

GET /portal/api/v1/member/outstandingbalance

Get a list of member's outstanding charges

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: MemberCharge
error: string

GET /portal/api/v1/member/profile

Get member's account information.

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: Member
error: string

POST /portal/api/v1/member/profile

Update member's account information.

api_key

API Key for integration

formData string
token

Returned token from login call

formData string
firstname

Firstname of the member

formData string
surname

Surname of the member

formData string
dob

Date of birth of the member in ISO format (YYYY-MM-DD)

formData string (date)
gender

Gender of the member. Either "M", "F", or "O"

formData string
phonecell

Cellphone number of the member

formData string
phonehome

Home phone number of the member

formData string
addressstreet

Street of member address

formData string
addresssuburb

Suburb of member address

formData string
addresscity

City of member address

formData string
addresscountry

Country of member address

formData string
addressareacode

Area code of member address

formData string
receivesms

Whether member is subscribed to SMS communication

formData boolean
receiveemail

Whether member is subscribed to email communication

formData boolean
200 OK

Successful response

result: string
error: string

GET /portal/api/v1/member_classbookings

Retrieves a list of upcoming class bookings for the logged in member

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: object
bookings: object[]
waitlist: object[]
error: string

GET /portal/api/v1/member_servicebookings

Retrieves a list of upcoming service bookings for the logged in member

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: object[]
error: string

GET /portal/api/v1/members

Retrieves a list of all current members

api_key

API Key for integration

query string
when

Only show members updated after this timestamp, in format YYYY-MM-DD HH:mm:ss

query string
200 OK

Successful response

result: object[]
error: string

GET /portal/api/v1/memberships

Retrieves a list of the available memberships that can be purchased. If a token for a logged in member is provided, the memberships will be those available for that member.

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: object[]
error: string

POST /portal/api/v1/memberships

Adds a membership to the logged in member

api_key

API Key for integration

formData string
token

Returned token from login call

formData string
membershiptypeid

ID of the membership to add to the member

formData integer
startdate

Date for the membership to start in ISO format (YYYY-MM-DD)

formData date
200 OK

Successful response

result: string
error: string

GET /portal/api/v1/memberships/cancel

Returns a list of membership cancellation reasons

api_key

API Key for integration

query string
token

Returned token from login call

query string
200 OK

Successful response

result: object[]
error: string

POST /portal/api/v1/memberships/cancel

Suspends a member's memberships in GymMaster. Requires a start date, end date, and a reason for the suspension.

api_key

API Key for integration

formData string
token

Returned token from login call

query string
membershipid

The ID of the member's membership to cancel

formData integer
enddate

The date that the membership will be cancelled from in ISO format (YYYY-MM-DD)

formData string
reason

The ID representing a cancellation reason for the member's membership cancellation.

formData integer
feedback

Any extra feedback/information

formData string
200 OK

Successful response

result: string
error: string

POST /portal/api/v1/memberships/suspend

Suspends a member's memberships in GymMaster. Requires a start date, end date, and a reason for the suspension.

api_key

API Key for integration

formData string
token

Returned token from login call

query string
startdate

The start date of the member's suspension in ISO format (YYYY-MM-DD)

formData string
enddate

The end date of the member's suspension in ISO format (YYYY-MM-DD)

formData string
reason

The reason for the member's suspension

formData date
200 OK

Successful response

result: string
error: string

POST /portal/api/v1/prospect/create

Create a prospect in GymMaster Will update an existing prospect if the details match.

api_key

API Key for integration

formData string
firstname

Firstname of the new prospect

formData string
surname

Surname of the new prospect

formData string
email

Email of the new prospect

formData string
phonecell

Cellphone number of the new prospect

formData string
gender

Gender number of the new prospect, either 'M', 'F', or 'O'

formData string
addressstreet

Street address of the new prospect

formData string
addresssuburb

Suburb of of the new prospect

formData string
addresscity

City of the new prospect

formData string
addressareacode

Areacode/Postcode of the new prospect

formData string
addresscountry

Country of the new prospect

formData string
dob

Date of birth of the new prospect in ISO format (YYYY-MM-DD)

formData date
notes

Any additional information about the prospect

formData string
200 OK

Successful response

result: string
error: string

POST /portal/api/v1/signup

Signup a new member in GymMaster, with a membership. If successful, the provided email and password can be used to login as the member. Will return the membership ID of their new membership.

api_key

API Key for integration

formData string
firstname

Firstname of the new member

formData string
surname

Surname of the new member

formData string
dob

Date of birth of the new member in ISO format (YYYY-MM-DD)

formData date
email

Email of the new member

formData string
password

Password of the new member

formData string
membershiptypeid

Membership for the new member to signup with

formData integer
phonecell

Cellphone number of the new member

formData string
phonehome

Home phone number of the new member

formData string
addressstreet

Street address of the new member

formData string
addresssuburb

Suburb of of the new member

formData string
addresscity

City of the new member

formData string
addressareacode

Areacode/Postcode of the new member

formData string
gender

Gender of the member. Either "M", "F", or "O"

formData string
companyid

Club the member is joining. ID number can be found in GymMaster.

formData integer
startdate

Start date of the new member's membership in ISO format (YYYY-MM-DD)

formData date
firstpaymentdate

First payment date of the new member's membership in ISO format (YYYY-MM-DD)

formData date
200 OK

Successful response

result: string
error: string
memberid: string
membershipid: string

Schema definitions

Class: object

id: integer

Unique identifier representing a class booking in GymMaster

classname: string

Name of the class

bookingname: string

Name of the booking (usually the same as classname)

classid: integer

Unique identifier representing a class type in GymMaster

arrival: string (date)

Date the booking is on

starttime: string

Time the booking starts at in format HH:MM:SS

endtime: string

Time the booking ends at in format HH:MM:SS

start_str: string

Time the booking starts at in format HH:MMAM

end_str: string

Time the booking ends at in format HH:MMAM

already_booked: boolean

Whether the logged in member has already booked in

already_booked_id: integer

If the member has already booked in, this is the ID of their booking, which can be used to cancel their booking

availability: string

Availability status of this class

bookable: boolean

Whether the logged in member is allowed to book in

location: string

The resource the booking is on

max_waitinglist: integer

The maximum number of members able to go on the waitlist

multiplebookings: boolean

Whether the class allows multiple bookings by the same member

num_students: integer

The number of members booked in

price: string

The price of the booking (w/ currency symbol)

seatallocation: boolean

Whether the class allows members to select their seat

staffname: string

The staff member assigned to the class

substitute_staff: boolean

Whether the assigned staff member is a substitute

waitlist_count: integer

The number of members in the waitlist for the class

dayofweek: string

The day of the week the booking is on

staffphoto: string

URL for the image for the staff member assigned to the class

max_students: integer

The maximum number of class attendees allowed in this class booking

spacesfree: integer

The number of spaces remaining free for this class booking

bgcolour: string

The hex code of the colour set for this class type in GymMaster

image: string

The URL for the logo for this class type

description: string

The description of this class

online_instruction: string

Extra information for this class

ClassSchedule: object

id: integer

Unique identifier representing a class booking in GymMaster

name: string

Name of the class

classid: integer

Unique identifier representing a class type in GymMaster

arrival: string (date)

Date the booking is on

dayofweek: string

The day of the week the booking is on

starttime: string

Time the booking starts at

endtime: string

Time the booking ends at

availability: string

Availability status of this class

resourceid: integer

Unique identifier representing the resource in GymMaster

location: string

The resource the booking is on

staffid: string

Unique identifier representing the staff member assigned to the class in GymMaster

staffname: string

The staff member assigned to the class

staffphoto: string

URL for the image for the staff member assigned to the class

description: string

The description of this class

companyid: integer

Unique identifier representing the club in GymMaster

companyname: string

The club the booking is on

max_students: integer

The maximum number of class attendees allowed in this class booking

spacesfree: integer

The number of spaces remaining free for this class booking

bgcolour: string

The hex code of the colour set for this class type in GymMaster

image: string

The URL for the logo for this class type

online_instruction: string

Extra information for this class

Club: object

id: integer

Unique identifier representing a club in GymMaster

name: boolean

The name of the club

LinkedMember: object

id: integer

Unique identifier representing this linked member in GymMaster

firstname: string

The first name of the linked member

surname: string

The last name of the linked member

relationship: string

The relationship of the parent member to the linked member

Measurement: object

id: integer

Unique identifier representing this measurement in GymMaster

latest: boolean

If this measurement is the latest measurement recorded for a member

measured_on: string

The date the measurement occurred on

linked_members: object[]

An array of measurement values that are part of this measurement

MeasurementValue: object

category: string

The category this measurement value is sorted under

name: string

The name of this measurement value

current_value: number

The current value of this measurement value, as of the latest measurement

value: number

The value of this measurement value

progress: number

The difference between value and current_value

unit: string

The unit of this measurement value

Member: object

id: integer

Unique identifier representing a member in GymMaster

firstname: string

Firstname of the member

surname: string

Surname of the member

email: string

Email of the member

dob: string (date)

Date of birth of the member in ISO format (YYYY-MM-DD)

gender: string

Gender of member. Either "M", "F", or "O"

phonecell: string

Cellphone number of the member

phonehome: string

Home phone number of the member

addressstreet: string

Street of member address

addresssuburb: string

Suburb of member address

addresscity: string

City of member address

addresscountry: string

Country of member address

addressareacode: string

Area code of member address

receivesms: string

Whether member is subscribed to SMS communication

receiveemail: string

Whether member is subscribed to email communication

goal: string

Member joining goal

joindate: string

Date the member joined in ISO format (YYYY-MM-DD)

sourcepromotion: string

How the member found out about club

memberphoto: string

URL for the image for the member's photo

totalvisits: integer

The total amount of visits the member has made

totalpts: integer

The total amount of bookings the member has made

totalclasses: integer

The total amount of classes the member has booked into

linked_members: object[]

An array of members that are paid for by this member

MemberCharge: object

occurred: integer

The date this charge occurred in ISO format (YYYY-MM-DD)

note: string

The note on the charge

total: string

The amount of the charge

MemberClassBooking: object

id: integer

Unique identifier representing a booking in GymMaster

day: string (date)

Date the booking occurs on in ISO format (YYYY-MM-DD)

starttime: string

Time the booking starts at in format HH:MM:SS

endtime: string

Time the booking ends at in format HH:MM:SS

start_str: string

Time the booking starts at in format HH:MMAM

end_str: string

Time the booking ends at in format HH:MMAM

name: string

The name of the class

location: string

The resource the booking is on

is_trainer: boolean

Whether the resource the booking is on is a trainer

seat: integer

The seat number the booking has

staffname: string

The staff member assigned to the booking

substitute_staff: boolean

Whether the assigned staff member is a substitute

staffphoto: string

URL for the image for the staff member assigned to the class

description: string

The description of this class

dayofweek: string

The day of the week the booking is on

max_students: integer

The maximum number of class attendees allowed in this class booking

spacesfree: integer

The number of spaces remaining free for this class booking

bgcolour: string

The hex code of the colour set for this class type in GymMaster

image: string

The URL for the logo for this class type

parentid: integer

The ID of the parent class booking for this booking

MemberMembership: object

id: integer

Unique identifier representing this member membership in GymMaster

name: string

The name of this membership

price: string

The price of this membership

startdate: string (date)

The start date of this membership in ISO format (YYYY-MM-DD)

enddate: string (date)

The end date of this membership in ISO format (YYYY-MM-DD), or "Open Ended" if there is no end date

visitsused: integer

The visits used with this membership

visitlimit: integer

The visits limit on this membership, if any

MemberServiceBooking: object

id: integer

Unique identifier representing a booking in GymMaster

day: string (date)

Date the booking occurs on in ISO format (YYYY-MM-DD)

starttime: string

Time the booking starts at in format HH:MM:SS

endtime: string

Time the booking ends at in format HH:MM:SS

start_str: string

Time the booking starts at in format HH:MMAM

end_str: string

Time the booking ends at in format HH:MMAM

name: string

The resource the booking is on

type: string

The type of booking it is

Membership: object

id: integer

Unique identifier representing a membership type in GymMaster

name: string

Name of the membership type

description: string

Additional information about the membership type

price: string

Price of the membership type (w/ currency symbol)

pricedescription: string

Information about the price

signupfee: string

Signup fee of the membership type (w/ currency symbol)

onlinecash: boolean

Whether payment is usually skipped in the online signup process

programme_ref: string

Unique hash representing the membership type

programmegroupid: string

ID of the programme group this membership type is part of

startdate: string (date)

Startdate of the membership type

MembershipCancellationReason: object

id: integer

Unique identifier representing this cancellation reason in GymMaster

name: string

The label for this cancellation reason

MemberWaitlist: object

id: integer

Unique identifier representing a waitlist booking in GymMaster

day: string (date)

Date the waitlist booking occurs on in ISO format (YYYY-MM-DD)

starttime: string

Time the waitlist booking starts at in format HH:MM:SS

endtime: string

Time the waitlist booking ends at in format HH:MM:SS

start_str: string

Time the waitlist booking starts at in format HH:MMAM

end_str: string

Time the waitlist booking ends at in format HH:MMAM

name: string

The name of the class

location: string

The resource the waitlist booking is on

is_trainer: boolean

Whether the resource the waitlist booking is on is a trainer

priority: integer

Which number in the queue this waitlist booking is from being booked in

staffname: string

The staff member assigned to the booking

substitute_staff: boolean

Whether the assigned staff member is a substitute

staffphoto: string

URL for the image for the staff member assigned to the class

description: string

The description of this class

Resource: object

id: integer

Unique identifier representing a resource booking in GymMaster

name: string

Name of the resource

companyid: integer

Unique identifier representing the club in GymMaster

companyname: string

The name of the club this resource is assigned to

Seat: object

seatnum: integer

Seat number in the class

taken: boolean

Whether the seat is taken

Service: object

bookingtypeid: integer

ID number of the booking type

membershipid: integer

ID number of the membership which would be used for this service

benefitid: integer

ID number of the benefit which would be used for this service

servicename: string

Name of the booking type

status: string

Name of the benefit used

price: string

The price of the booking made with this service (w/ currency symbol)

Session: object

day: string (date)

The date the session is on

dayofweek: string

The day of the week the session is on

bookingstart: string

The time the session starts at in format HH:MM:SS

bookingend: string

The time the session ends at in format HH:MM:SS

start_str: string

The time the session starts at in format HH:MMAM

end_str: string

The time the session ends at in format HH:MMAM

price: string

The price of this session (w/ currency symbol)

resource: integer

ID number the resource the session is on

Back to GymMaster Software