Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyTypeDescription
idIntegerThe Club OS unique user id.

billingSystemId

StringThe billing system unique user id (integrated clubs only).
roleStringThe Club OS role of the user (Member/Prospect), i.e. "Member" or "Prospect".
firstNameStringThe first name of the user.
lastNameStringThe last name of the user.
emailStringThe email of the user.
mobilePhoneStringThe mobile phone of the user.
homePhoneString

The home phone of the user.

workPhoneString

The work phone of the user.

dateOfBirthDateThe date of birth of the user.
genderStringM or F, the gender of the user.
createdDateDateTimeThe UTC timestamp when the user was first created in the Club OS system.
guestPassStartDateThe guest pass start date.
guestPassEndDateThe guest pass end date.
addressLine1StringThe user's address line 1.
addressLine2StringThe user's address line 2.
cityStringThe user's city.
stateStringThe user's state (2 letter abbreviation)
countryStringThe user's country (2 letter abbreviation)
originStringThe user's origin (how they first contacted the club).
marketingSourceStringThe marketing source of the user (how they heard about the club).
workoutGoalPerWeekIntegerThe number of workouts this user plans on doing per week.
startWeightDecimalThe starting weight of the user.
goalWeightDecimalThe goal weight of the user.
followUpStatusStringThe current follow up status of the user.
nextFollowUpDateDateThe next scheduled follow up date for the user.
interestsString[]The list of interests this user has selected in Club OS.
trainersEmployee[]The list of trainers assigned to this member.
pitchesPitch[]The list of pitches this user has in their profile. A pitch will contain all the information captured during the pitch, and a timestamp for each pitch.
Pitch.idIntegerThe id of the pitch

Pitch.tfoUserId

IntegerThe Club OS userId of the user who the pitch was performed.
Pitch.locationIdIntegerThe Club OS locationId
Pitch.pitchDataJsonJson object containing all the data captured in the pitch
Pitch.pitchTypeStringThe type of pitch
Pitch.startDateTimeDateThe date and time that the pitch begun.
Pitch.endDateTimeDateThe date and time that the pitch ended.
Pitch.createdByIntegerThe Club OS userId of the user (employee) who performed the pitch
Pitch.createdDateTimeDateThe timestamp that the pitch was created.

...