Back to GymMaster Software

GymMaster Member Portal API

Version: 445

Schemes:

Summary

Path Operation Description
/portal/api/v1/booking/classes GET
POST
/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/email/feedback POST
/portal/api/v1/email/resetpassword POST
/portal/api/v1/email/sendemailtemplate POST
/portal/api/v1/login POST
/portal/api/v1/member/cancelbooking POST
/portal/api/v1/member/profile GET
POST
/portal/api/v1/member_classbookings GET
/portal/api/v1/member_servicebookings GET
/portal/api/v1/memberships GET
POST
/portal/api/v1/prospect/create 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
200 OK

Successful response

result: object
bookings: 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
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
bookings: 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
resources: 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
resources: 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 benefit to book with

formData integer
bookingstart

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

formData integer
bookingend

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

formData integer
price

The price of the booking

formData integer
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
resources: object[]
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. Either both email and password are required, or member_ref.

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
member_ref

Unique reference representing member in GymMaster

formData string
200 OK

Successful response

result: object
token: string
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/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" or "F"

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
bookings: object[]
error: string

GET /portal/api/v1/memberships

Retrieves a list of the available memberships that can be purchased by 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
resources: 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
membership

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: object
resources: object[]
error: string

POST /portal/api/v1/prospect/create

Create a prospect in GymMaster Will update an existing prospect if the details match. If successful, will return member_ref which can be used to login as member.

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' or 'F'

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
member_ref: 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

ID of the booking representing the member already booked in

already_booked_waitlist_id: integer

ID of the waitlist booking representing the member already in the waitlist

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_students: integer

The maximum number of members able to book in

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

percentfull: number (double)

The percentage full the class is

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

weekday: string

The day of the week the booking is on

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" or "F"

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

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

cancelurl: string

URL you can go to to cancel the booking manually

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

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

cancelurl: string

URL you can go to to cancel the booking manually

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

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

cancelurl: string

URL you can go to to cancel the waitlist booking manually

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

Resource: object

id: integer

Unique identifier representing a resource booking in GymMaster

name: string

Name of the resource

informationlink: string

URL with more information about the resource

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

weekday: 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