GET api/contacts?studentId={studentId}&salutationId={salutationId}&name={name}&nameContains={nameContains}&surname={surname}&surnameContains={surnameContains}&gender={gender}&dateOfBirth={dateOfBirth}&emailAddress={emailAddress}&countryOfResidenceId={countryOfResidenceId}&countryOfCitizenshipId={countryOfCitizenshipId}&countryOfBirthId={countryOfBirthId}&dateCreatedFrom={dateCreatedFrom}&dateCreatedTo={dateCreatedTo}&inactive={inactive}&offset={offset}&limit={limit}&returnTotal={returnTotal}

Optional case-insensitive filter on Contacts with a studentId in the given institution that matches the provided value.

Optional filter on Contacts with a SalutationId that matches the provided value.

Optional case-insensitive filter on Contacts with a given name that matches the provided value.

Optional case-insensitive filter on Contacts with a given name containing the provided value.

Optional case-insensitive filter on Contacts with a surname that matches the provided value.

Optional case-insensitive filter on Contacts with a surname containing the provided value.

Optional case-insensitive filter on Contacts with a gender that matches the provided value.

Optional filter on Contacts with a birth date that matches the provided value.

Optional case-insensitive filter on Contacts with a primary email address that matches the provided value.

Optional filter on Contacts with a CountryOfResidenceId that matches the provided value.

Optional filter on Contacts with a CountryOfCitizenshipId that matches the provided value.

Optional filter on Contacts with a CountryOfBirthId that matches the provided value.

Optional filter on Contacts that were created on a date from the provided value.

Optional filter on Contacts that were created on a date up to (inclusive) the provided value.

Filter indicating whether to retrieve active or inactive records.

The position in the collection of Contacts from which to start returning data from.

The maximum amount of Contacts that can be returned in any one call. Maximum allowed is 20.

Whether to include the total amount of Contacts in the database that match the filter specified.

The primary key of the record in the Hobsons database. Ignored for PUT (except bulk updates) and POST requests sent to the API.

The unique identifier for the contact in the institution.

A reference to the primary key of the Salutation record that is binded to the contact.

The name of the Salutation record that is binded to the contact. Ignored for PUT and POST requests sent to the API.

The given name of the contact.

The family name of the contact.

Any additional names that are given to the contact.

Any aliases that the contact may also be known by.

Any names that the contact previously held.

The gender of the Contact. Valid values are 'M', 'F', 'X' and 'N', which denote Male, Female, Gender Neutral and Not Disclosed respectively.

The date of birth of the Contact. Note that only the date component it's used, the time component will be ignored if specified.

The primary email address that is used to communicate with the contact.

Whether the student has a permanent resident visa in the country that the institution is in.

A reference to the primary key of the Country record that is binded as the contact's country of residence.

The name of the Country record that is binded as the contact's country of residence. Ignored for PUT and POST requests sent to the API.

A reference to the primary key of the Country record that is binded as the contact's country of citizenship.

The name of the Country record that is binded as the contact's country of citizenship. Ignored for PUT and POST requests sent to the API.

A reference to the primary key of the Country record that is binded as the contact's country of birth.

The name of the Country record that is binded as the contact's country of birth. Ignored for PUT and POST requests sent to the API.

The date that the Contact record was created (in the Hobsons database). Ignored for PUT and POST requests sent to the API.

The date that the Contact record was last modified (in the Hobsons database). Ignored for PUT and POST requests sent to the API.

A reference to the primary key of the HeatStatus record that is binded as the contact's current HeatStatus.

The name of the HeatStatus record that is binded as the contacts current HeatStatus. Ignored for PUT and POST requests sent to the API.

The reason why the Contact's HeatStatusId value is changing (or created). The provided value will be stored as part of a new ContactHeatStatus record. Required for PUT requests sent to the API. For POST requests if a reason is not provided, Hobsons will set a default reason. Used ONLY for PUT and POST requests sent to the API. For GET requests always returned as NULL.

A reference to the primary key of the SubChannel record that is associated with this record. For POST or PUT requests sent to the API where this value is changing, the SubChannel record must belong to the parent Channel named 'External'.

The name of the SubChannel record that is associated with this record. Ignored for PUT and POST requests sent to the API.

A reference to the primary key of the Channel record that is the parent of the SubChannel record. Ignored for PUT and POST requests sent to the API.

The name of the Channel record that is the parent of the SubChannel record. Ignored for PUT and POST requests sent to the API.

A reference to the primary key of the ContactStatus record that is currently associated with this record.

The name of the ContactStatus record that is currently associated with this record. Ignored for PUT and POST requests sent to the API.

The reason why the Contact's ContactStatusId value is changing (or created). The provided value will be stored as part of a new ContactContactStatus record. Required for PUT requests sent to the API. For POST requests if a reason is not provided, Hobsons will set a default reason. Used ONLY for PUT and POST requests sent to the API. For GET requests always returned as NULL.

A reference to the primary key of the Intake record that is currently associated with this record. Ignored for PUT and POST requests sent to the API.

The name of the Intake record that is currently associated with this record. Ignored for PUT and POST requests sent to the API.