Version: v1058
Retrieves a schedule of classes in a given week. This will get all classes, regardless of if the current member can book into them.
The response from this endpoint may be cached for up to 5 minutes.
api_key | API Key for integration |
query | string | |
week | 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 |
Successful response
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 |
Successful response
Get a list of available service bookings using the provided service & benefit. If no token is provided, a companyid must be.
api_key | API Key for integration |
query | string | |
token | Returned token from the login call |
query | string | |
serviceid | The ID number of the service to use |
query | integer | |
companyid | Only show times available at this club |
query | integer |
Successful response
Book a service booking
application/x-www-form-urlencoded
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 | |
serviceid | The ID number of the service 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 | |
roomid | The ID of the room to book |
formData | integer | |
equipmentid | The ID of the equipment to book |
formData | integer |
Successful response
Get a list of available equipment at the given time
The response from this endpoint may be cached for up to 5 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from the login call |
query | string | |
serviceid | The ID of the service being booked into |
query | integer | |
day | The date of the booking in ISO format (YYYY-MM-DD) |
query | string | |
bookingstart | The start of the booking in format HH:MM:SS |
query | string | |
bookingend | The end of the booking in format HH:MM:SS |
query | string |
Successful response
Get a list of available rooms at the given time.
The response from this endpoint may be cached for up to 5 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from the login call |
query | string | |
serviceid | The ID of the service being booked into |
query | integer | |
day | The date of the booking in ISO format (YYYY-MM-DD) |
query | string | |
bookingstart | The start of the booking in format HH:MM:SS |
query | string | |
bookingend | The end of the booking in format HH:MM:SS |
query | string |
Successful response
Get a list of services that can be used booking on a given resource when making a service booking. If no token is provided, a companyid must be.
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 | |
companyid | Only show services available at this club |
query | integer |
Successful response
Get a list of the clubs set up
api_key | API Key for integration |
query | string |
Successful response
Sends feedback to the facility from a member given their email address
application/x-www-form-urlencoded
api_key | API Key for integration |
formData | string | |
Email of the member sending feedback |
formData | string | ||
message | The feedback being sent |
formData | string |
Successful response
Sends a password reset link email to any member with the provided email
application/x-www-form-urlencoded
api_key | API Key for integration |
formData | string | |
Member email who needs to reset their password |
formData | string |
Successful response
Send an email to a member using a specific GymMaster email template
application/x-www-form-urlencoded
api_key | API Key for integration |
formData | string | |
Email of the member to send the email to |
formData | string | ||
templateid | Unique identifier representing an email template in GymMaster |
formData | integer |
Successful response
Login as member to perform actions using member account. Either the member's email & password can be used, or their ID. Note that logging in with only ID requires the use of 'API Key for Staff' instead of 'API Key for Members'. Use returned token for any future calls. The lifespan of the token in seconds (generally 1 hour) will be returned along with the token.
Also returns ID of member logged in as, for reference.
application/x-www-form-urlencoded
api_key | API Key for integration |
formData | string | |
Member email to log in as |
formData | string | ||
password | Member password to log in as |
formData | string | |
memberid | Member ID to login as |
formData | integer |
Successful response
Cancel a member booking
application/x-www-form-urlencoded
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 |
Successful response
Get a member's current membership benefit balances.
The response from this endpoint may be cached for up to 2 minutes.
api_key | API Key for integration. |
query | string | |
token | Returned token from login call. |
query | string |
Successful response
Get a list of member's current memberships
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Get a list of member's outstanding charges
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Pay for a member's outstanding charges
application/json
API Key for integration
Returned token from login call
The list of charges to pay for
Must be set to 1.
Successful response
Get member's account information.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Update member's account information.
multipart/form-data
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 | |
Email address 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 | |
memberphoto | An image/photo for the member. Accepts jpg, png, or base64 encoded string |
formData | file | |
customtextX | Detail for member's Custom Text X where X |
formData | string | |
customdropdownX | Value of option for member's Custom Dropdown X |
formData | integer | |
custombooleanX | Whether to enable member's Custom Checkbox X |
formData | boolean | |
customdateX | Date in ISO format (YYYY-MM-DD) for member's Custom Date X |
formData | string |
Successful response
Get a count of member's visits grouped by month.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration. |
query | string | |
token | Returned token from login call. |
query | string |
Successful response
Retrieves a list of all current members.
The response from this endpoint may be cached for up to 10 minutes.
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 | |
companyid | Filter the members list by company, only members from this company will be returned. |
query | integer |
Successful response
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.
The response from this endpoint may be cached for up to 2 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Adds a membership to the logged in member
application/x-www-form-urlencoded
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 | string |
Successful response
Returns a list of membership cancellation reasons.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Cancel a member's membership as of a given date.
application/x-www-form-urlencoded
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 |
Successful response
Suspends a member's memberships in GymMaster. Requires a start date, end date, and a reason for the suspension.
application/x-www-form-urlencoded
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 | string |
Successful response
Create a prospect in GymMaster Will update an existing prospect if the details match. Use returned token for any future calls. The lifespan of the token in seconds (generally 1 hour) will be returned along with the token. In order to get a new token, use the login endpoint with the memberid value.
multipart/form-data
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 of the new prospect |
formData | string | ||
companyid | Club the prospect is joining. ID number can be found via the companies endpoint, or in GymMaster. |
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 | string | |
notes | Any additional information about the prospect |
formData | string | |
memberphoto | An image/photo for the prospect. Accepts jpg, png, or base64 encoded string |
formData | file | |
promotion_id | The ID representing a promotion in GymMaster |
formData | integer |
Successful response
Get a list of applicable settings.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration |
query | string |
Successful response
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. Use returned token for any future calls. The lifespan of the token in seconds (generally 1 hour) will be returned along with the token. In order to get a new token, use the login endpoint with the memberid value.
application/x-www-form-urlencoded
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 | string | |
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 via the companies endpoint, or in GymMaster. |
formData | integer | |
startdate | Start date of the new member's membership in ISO format (YYYY-MM-DD) |
formData | string | |
firstpaymentdate | First payment date of the new member's membership in ISO format (YYYY-MM-DD) |
formData | string |
Successful response
Get the current version number of GymMaster.
api_key | API Key for integration |
query | string |
Successful response
Retrieves a list of all workouts for a member.
The response from this endpoint may be cached for up to 5 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Retrieves a list of upcoming bookings that the logged in member can book into.
The response from this endpoint may be cached for up to 2 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string | |
week | Date to show the classes of in ISO format (YYYY-MM-DD) - Week displayed will be 7 days from this date |
query | string |
Successful response
Book in to a class booking
application/json
API Key for integration
Returned token from login call
A list of the bookings to make
Unique identifier representing a class booking in GymMaster
Seat number to take
Retrieves a list of members that are attending a class booking. This returns an array of member names.
api_key | API Key for integration |
query | string | |
bookingid | Class booking to show attendee list for |
path | integer |
Successful response
Upload a generic file to the member's profile.
multipart/form-data
api_key | API Key for integration. |
formData | string | |
token | Returned token from login call. |
formData | string | |
upload | The file to upload. |
formData | file |
Successful response
Get a list of contact methods in GymMaster.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration. |
query | string |
Successful response
Pay for outstanding charges (including future dated charges) using any credit available. Will assign credit to oustanding charges oldest to newest. Optionally, pass in an array of postingids in order to only assign credit to them. If the account does not have enough credit to cover all oustanding charges, those that were unable to be covered will remain with an outstanding amount.
application/json
API Key for integration
Returned token from login call
The list of charges to pay for
Successful response
Rate a member's booking from 1 - 5.
api_key | API Key for integration. |
formData | string | |
token | Returned token from login call. |
formData | string | |
bookingid | ID of the member's booking to rate. |
formData | integer | |
rating | Rating of the booking from 1 - 5. |
formData | integer |
Successful response
Retrieves a list of upcoming bookings for the logged in member.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Checkin a member's booking, to specify that the member has attended
api_key | API Key for integration |
formData | string | |
token | Returned token from login call |
formData | string | |
bookingid | ID number of the booking |
formData | integer |
Successful response
Checkout a member's booking, to specify that the member has attended & left. Note, the booking will not be found if the booking has not been checked in yet.
api_key | API Key for integration |
formData | string | |
token | Returned token from login call |
formData | string | |
bookingid | ID number of the booking |
formData | integer |
Successful response
Retrieves a list of past bookings for the logged in member.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Check if a member exists with a given email address. Will return an error if the member already exists.
api_key | API Key for integration. |
query | string | |
Email address to check. |
query | string |
Successful response
string for missing member responses
ID of the found member
Is the current member considered current
Tries to check-in in the currently logged in member into the specified door. If check-in attempt is granted then any connected relays will open.
application/json
API Key for integration
Returned token from login call
Door number to check member into
Successful response
Human readable description of the reason the member was denied. null if member was granted access.
Outcome of the check-in attempt. 1 represents granted other codes are denied reasons.
Human readable description of the check-in attempt.
Retrieves a list of all measurements for a member.
The response from this endpoint may be cached for up to 2 minutes.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string |
Successful response
Records a new measurement for a member
application/json
API Key for integration
Returned token from login call
The date this measurement occurred on in ISO format (YYYY-MM-DD)
A list of the measurements to record
Unique identifier representing the type of measurement
The value of this measurement
A list of the progress photos for this measurement
Filename to save this file with
Base64 encoded image file
Successful response
Log that a member has agreed to all agreements for their membership.
api_key | API Key for integration |
formData | string | |
token | Returned token from login call |
formData | string | |
membershipid | ID of the member's membership |
path | integer |
Successful response
Downloads a member's PDF membership contract. Returns a PDF response if found, otherwise will return a 404.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string | |
membershipid | ID of the member's membership |
path | integer |
application/pdf
Successful response
Membership not found
Saves a member's digital signature. This takes a base64 image.
api_key | API Key for integration |
formData | string | |
token | Returned token from login call |
formData | string | |
file | Base64-encoded image of digital signature |
formData | string | |
membershipid | ID of the member's membership |
formData | integer | |
source | The source event/sender to store against the signature |
formData | strong |
Successful response
Get a count of member's visits grouped by day. Water visits are a subset of visits where checked in to a door with name including 'sauna', 'plunge', 'pool', or 'spa'.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration. |
query | string | |
token | Returned token from login call. |
query | string |
Successful response
Retrieves agreement content for a membership type. This typically consists of Terms & Conditions, and a Waiver.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string | |
membershiptypeid | Membership to show agreement content for |
path | integer |
Successful response
Log a payment from a member into GymMaster.
application/x-www-form-urlencoded
api_key | API Key for integration. |
formData | string | |
token | Returned token from login call. |
query | string | |
amount | The amount that was paid by the member. |
formData | string | |
note | A note extra information about the payment. |
formData | string | |
paymentmethod_name | The name of the payment method. |
formData | string |
Successful response
Get a list of products stored in GymMaster.
api_key | API Key for integration. |
query | string |
Successful response
Purchase products as a member
application/json
API Key for integration
Returned token from login call
A list of the products to purchase
Unique identifier representing the product
The quantity of this product to purchase
Successful response
Get a list of promotions stored in GymMaster.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration. |
query | string |
Successful response
Gets a list of any questionnaires that a marked as available online.
api_key | API Key for integration |
query | string |
Successful response
Get a list of previous answers to a questionnaire that a member has provided.
api_key | API Key for integration |
query | string | |
token | Returned token from login call |
query | string | |
questionnaireid | Questionnaire to get answers for |
path | integer |
Successful response
Get a list of staff set as sales reps in GymMaster.
The response from this endpoint may be cached for up to 10 minutes.
api_key | API Key for integration. |
query | string |
Successful response
Unique identifier representing an agreement in GymMaster
The name of this agreement
The HTML body of the agreement
A list of points to agree to
A string representation of the member's answer. For boolean-type questions, this will either be "true" or "false".
Unique identifier representing a question in GymMaster
Date when the member submitted this set of answers in ISO format (YYYY-MM-DD)
Answers to each question provided in this set of answers
Unique identifier representing a class booking in GymMaster
Name of the class
Name of the booking (usually the same as classname)
Unique identifier representing a class type in GymMaster
Date the booking is on
Time the booking starts at in format HH:MM:SS
Time the booking ends at in format HH:MM:SS
Time the booking starts at in format HH:MMAM
Time the booking ends at in format HH:MMAM
If the member has already booked in, this is the ID of their booking, which can be used to cancel their booking
Availability status of this class
Whether the logged in member is allowed to book in
The resource the booking is on
The maximum number of members able to go on the waitlist
Whether the class allows multiple bookings by the same member
The number of members booked in
The price of the booking (w/ currency symbol)
Whether the class allows members to select their seat
The staff member assigned to the class
Whether the assigned staff member is a substitute
The number of members in the waitlist for the class
The day of the week the booking is on
URL for the image for the staff member assigned to the class
The maximum number of class attendees allowed in this class booking
The number of spaces remaining free for this class booking
The hex code of the colour set for this class type in GymMaster
The URL for the logo for this class type
The description of this class
Extra information for this class
Unique identifier representing a class booking in GymMaster
Name of the class
Unique identifier representing a class type in GymMaster
Date the booking is on
The day of the week the booking is on
Time the booking starts at
Time the booking ends at
Availability status of this class
Unique identifier representing the resource in GymMaster
The resource the booking is on
Unique identifier representing the staff member assigned to the class in GymMaster
The staff member assigned to the class
URL for the image for the staff member assigned to the class
The description of this class
Unique identifier representing the club in GymMaster
The club the booking is on
The maximum number of class attendees allowed in this class booking
The number of spaces remaining free for this class booking
The hex code of the colour set for this class type in GymMaster
The URL for the logo for this class type
Extra information for this class
Unique identifier representing a club in GymMaster
The name of the club
Name of the billing provider selected on the Billing Details under Club Details in GymMaster
Unique identifier representing this linked member in GymMaster
The first name of the linked member
The last name of the linked member
The relationship of the parent member to the linked member
Unique identifier representing this measurement in GymMaster
If this measurement is the latest measurement recorded for a member
The date the measurement occurred on
A list of URLs of photos associated with this measurement
An array of measurement values that are part of this measurement
The category this measurement value is sorted under
Unique identifier representing the type of measurement
The name of this measurement value
The value of this measurement value
The unit of this measurement value
The unit group of this measurement value
Unique identifier representing a member in GymMaster
Firstname of the member
Surname of the member
Email of the member
Date of birth of the member in ISO format (YYYY-MM-DD)
Gender of member. Either "M", "F", or "O"
Cellphone number of the member
Home phone number of the member
Street of member address
Suburb of member address
City of member address
Country of member address
Area code of member address
Whether member is subscribed to SMS communication
Whether member is subscribed to email communication
Member joining goal
Date the member joined in ISO format (YYYY-MM-DD)
How the member found out about club
URL for the image for the member's photo
The total amount of visits the member has made
The total amount of service bookings the member has attended
The total amount of classes the member has attended
An array of members that are paid for by this member
The ID of the charge
The date this charge occurred in ISO format (YYYY-MM-DD)
The note on the charge
The amount of the charge
Unique identifier representing a booking in GymMaster
Date the booking occurs on in ISO format (YYYY-MM-DD)
Time the booking starts at in format HH:MM:SS
Time the booking ends at in format HH:MM:SS
Time the booking starts at in format HH:MMAM
Time the booking ends at in format HH:MMAM
The name of the class
The resource the booking is on
Whether the resource the booking is on is a trainer
The seat number the booking has
The staff member assigned to the booking
Whether the assigned staff member is a substitute
URL for the image for the staff member assigned to the class
The description of this class
The day of the week the booking is on
The maximum number of class attendees allowed in this class booking
The number of spaces remaining free for this class booking
The hex code of the colour set for this class type in GymMaster
The URL for the logo for this class type
The ID of the parent class booking for this booking
Unique identifier representing this member membership in GymMaster
The name of this membership
The price of this membership
The start date of this membership in ISO format (YYYY-MM-DD)
The end date of this membership in ISO format (YYYY-MM-DD), or "Open Ended" if there is no end date
The visits used with this membership
The visits limit on this membership, if any
Unique identifier representing a booking in GymMaster
Date the booking occurred on in ISO format (YYYY-MM-DD)
Time the booking started in format HH:MM:SS
Time the booking ended in format HH:MM:SS
Time the booking starts at in format HH:MMAM
Time the booking ends at in format HH:MMAM
The price of the booking (w/ currency symbol)
The resource the booking is on
Name of the class for class bookings, or name of the facility for service bookings
Unique identifier representing a class type in GymMaster
Name of service for service booking or "Class Attendant" for class booking
Whether the member was checked in to the booking
Member's rating of the booking out of five
Member's feedback for the booking
Day of the week the booking occurred on, eg "Thursday"
Date the booking occurred on in format DD Mon YYYY
Unique identifier representing a booking in GymMaster
Date the booking occurs on in ISO format (YYYY-MM-DD)
Time the booking starts at in format HH:MM:SS
Time the booking ends at in format HH:MM:SS
Time the booking starts at in format HH:MMAM
Time the booking ends at in format HH:MMAM
The resource the booking is on
The type of booking it is
The name of the room booked
The name of the equipment booked