...
Property | Type | Description |
id | Integer | The Club OS unique user id. |
role | String | The Club OS role of the user (Member/Prospect) |
firstName | String | The first name of the user. |
lastName | String | The last name of the user. |
String | The email of the user. | |
mobilePhone | String | The mobile phone of the user. |
homePhone | String | The home phone of the user. |
workPhone | String | The work phone of the user. |
dateOfBirth | Date | The date of birth of the user. |
gender | String | M or F, the gender of the user. |
createdDate | DateTime | The UTC timestamp when the user was first created in the Club OS system. |
guestPassStart | Date | The guest pass start date. |
guestPassEnd | Date | The guest pass end date. |
addressLine1 | String | The user's address line 1. |
addressLine2 | String | The user's address line 2. |
city | String | The user's city. |
state | String | The user's state (2 letter abbreviation) |
country | String | The user's country (2 letter abbreviation) |
origin | String | The user's origin (how they first contacted the club). |
marketingSource | String | The marketing source of the user (how they heard about the club). |
workoutGoalPerWeek | Integer | The number of workouts this user plans on doing per week. |
startWeight | Decimal | The starting weight of the user. |
goalWeight | Decimal | The goal weight of the user. |
followUpStatus | String | The current follow up status of the user. |
nextFollowUpDate | Date | The next scheduled follow up date for the user. |
interests | String[] | The list of interests this user has selected in Club OS. |
pitches | Pitch[] | 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. |
Failure Response
If your request fails, you will receive a Response object containing the following:
...