Members

The member objects allow you to keep your member's data in a single place, track memberships, invoices, charges, fees, etc.

The API allows you to create, delete, and update your members. You can retrieve individual members as well as a list of all your members.

Here is the list of all properties the member object has:

Member

Property	Type	Required	Description
name	string	true	The full name of the member.
email	string	false	The email address of the member.
startDate	date	true	The start of the member. Determines the first date from which memberships can be assigned.
phone	string	false	The primary phone number of the member.
twitterHandle	string	false	The twitter handle of the member.
team	Company	false	Reference to the team the member belongs to.
contactPerson	boolean	false	True if the member is a contact person in his company.
billingPerson	boolean	false	True if the member is the billing person of his company and receives all the invoices.
signedDocuments	array	false	An array of strings containing the _ids of documents signed by a member.
office	Location	true	Reference to the location the member belongs to. It will default to the only location if left empty.
paymentDetails	array	readonly	Array containing all the names of the payment details added to the member account.
createdAt	date	readonly	The date when the member has been created at.
createdBy	id	readonly	The user that created the member.
modifiedAt	date	readonly	The date when the member has been modified for the last time. If no update is made this field will match the `createdAt` field.
modifiedBy	id	readonly	The user that did the last modification to the member. If no update is made this field will match the `createdBy` field.
status	enum	false	The member status. It could be `active`, `contact` or `former`.
calculatedStatus	enum	readonly	The actual member status calculated by the platform. Please, refer to this article for more information.
useDayPasses	boolean	false	Determines whether the member can use day passes. This should be manually turned on if adding day passes through the API.
portalPrivacy.hide	boolean	false	Determines whether the member's profile is visible in the members portal.
portalPrivacy.hideContactDetails	boolean	false	Determines whether the member's contact details are visible in the members portal.
portalPrivacy.hidePublicProfiles	boolean	false	Determines whether the member's (Twitter, LinkedIn, Facebook, Instragram) socials are visible in the members portal.