Returns summary data for a single contact within the database.
Note that Contact Details can be used to return more detailed information if this is needed.
| From Path | Type | Description |
|---|---|---|
| Id | Guid | External Identifier of the contact to be returned. |
Contact
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ClubId | Int32 |
The physical club to which a contact belongs. These can be returned using the following endpoint: Locations, using the FacilityId column. |
||||||||||||||||||||||||
| ContactGoals | [Int32] |
A list of goals which the contact holds. These can be found at the following endpoint: Goals. |
||||||||||||||||||||||||
| ContactInterests | [Int32] |
A list of interests which the contact holds. These can be found at the following endpoint: Interests. |
||||||||||||||||||||||||
| ContactObjections | [Int32] |
A list of objections for the contact not joining. These can be found at the following endpoint: Objections. |
||||||||||||||||||||||||
| DateOfBirth | DateTime | Date of birth of the contact. | ||||||||||||||||||||||||
| String |
Email address of the contact. Max 50 characters. |
|||||||||||||||||||||||||
| EmergencyName | String |
Name for an emergency contact, if any. Max 50 characters. |
||||||||||||||||||||||||
| EmergencyNumber | String |
A contact number for an emergency contact, if any. Max 25 characters. |
||||||||||||||||||||||||
| EnquiryType | Int32 |
The Enquiry Type ID that was used when this member joined. These can be found at the following endpoint: Ethnic Origins. |
||||||||||||||||||||||||
| EthnicOrigin | String |
Ethnic origin of the contact, represented as a string. Max 50 characters. Note that both the string value and the lookup value (see "EthnicOriginId") are written into the database. See Ethnic Origins |
||||||||||||||||||||||||
| EthnicOriginId | Int16 |
Ethnic origin of the contact, represented as a database ID. These are defined on a per-customer basis and are configurable. The following endpoint returns the list: Ethnic Origins Note that both the string value and the lookup value (see "EthnicOrigin") are written into the database. |
||||||||||||||||||||||||
| FirstName | String |
First name of the contact. Max 30 characters. |
||||||||||||||||||||||||
| Gender | The gender of the contact, if set. | |||||||||||||||||||||||||
|
||||||||||||||||||||||||||
| LastName | String |
Last name of the contact. Max 50 characters. |
||||||||||||||||||||||||
| MarketingPrefsConfirmed | Boolean | Whether the marketing preferences of the contact have been verified and approved. | ||||||||||||||||||||||||
| Mobile | String |
Mobile telephone number for the contact. Max 25 characters. |
||||||||||||||||||||||||
| OwnerId | Int32 | |||||||||||||||||||||||||
| Phone | String |
Home telephone number for the contact. Max 25 characters. |
||||||||||||||||||||||||
| Salesperson | Int32 |
The user identifier of the salesperson who sold this member. Note that there is currently no way of returning this using the API. |
||||||||||||||||||||||||
| Salutation | String | How the contact is addressed, for example in an email. | ||||||||||||||||||||||||
| Title | String |
Title (i.e. Mr, Mrs, Dr, etc) of the contact. Max 15 characters. |
||||||||||||||||||||||||
| YearOfStudy | Byte | Number of "Years of Study" of the contact. This is used in educational settings, otherwise it can be ignored. | ||||||||||||||||||||||||
| Address | Address of the contact. | |||||||||||||||||||||||||
|
||||||||||||||||||||||||||
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Gender": 1,
"Title": "sample string 3",
"Salutation": "sample string 4",
"DateOfBirth": "2026-02-05T00:11:46.6325485+00:00",
"Email": "sample string 5",
"HomeAddress": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"PostCode": "sample string 3",
"City": "sample string 4",
"Region": "sample string 5",
"Country": "sample string 6",
"CountryCode": "sample string 7"
},
"Phone": "sample string 6",
"Mobile": "sample string 7",
"EmergencyName": "sample string 8",
"EmergencyNumber": "sample string 9",
"EthnicOrigin": "sample string 10",
"EthnicOriginId": 1,
"YearOfStudy": 64,
"Salesperson": 1,
"EnquiryType": 1,
"OwnerId": 1,
"ContactInterests": [
1,
2,
3
],
"ContactGoals": [
1,
2,
3
],
"ContactObjections": [
1,
2,
3
],
"MarketingPrefsConfirmed": true,
"ClubId": 11
}
| Bundle(s) |
|---|
| Joining |