Contact

Respondent Item

NameDescriptionTypeAdditional information
ContactId

Unique contact number.

integer

FirstName

Contact’s first name.

string

Not available when retrieving respondents for an anonymous survey

LastName

Contact’s last name.

string

Not available when retrieving respondents for an anonymous survey

Email

Contact's email address.

string

Not available when retrieving respondents for an anonymous survey

LangCode

2-letter ISO 639-1 language code

string

CustomField1

A field which can be used to store additional contact information.

string

CustomField2

A field which can be used to store additional contact information.

string

CustomField3

A field which can be used to store additional contact information.

string

CustomField4

A field which can be used to store additional contact information.

string

CustomField5

A field which can be used to store additional contact information.

string

CustomField6

A field which can be used to store additional contact information.

string

CustomField7

A field which can be used to store additional contact information.

string

CustomField8

A field which can be used to store additional contact information.

string

CustomField9

A field which can be used to store additional contact information.

string

CustomField10

A field which can be used to store additional contact information.

string

CustomField11

A field which can be used to store additional contact information.

string

CustomField12

A field which can be used to store additional contact information.

string

CustomField13

A field which can be used to store additional contact information.

string

CustomField14

A field which can be used to store additional contact information.

string

CustomField15

A field which can be used to store additional contact information.

string

CustomField16

A field which can be used to store additional contact information.

string

CustomField17

A field which can be used to store additional contact information.

string

CustomField18

A field which can be used to store additional contact information.

string

CustomField19

A field which can be used to store additional contact information.

string

CustomField20

A field which can be used to store additional contact information.

string

Street

Contact's street name.

string

Not available when retrieving respondents for an anonymous survey

HouseNumber

Contact's house number.

string

Not available when retrieving respondents for an anonymous survey

Suite

Contact's apt. number.

string

Not available when retrieving respondents for an anonymous survey

PostalCode

Postal code.

string

City

Contact's city.

string

State

ISO 3166-2 two-last letters state code.

string

3/lookup/states

Province

Contact's procince.

string

Phone

Contact's phone number in the E.164 format (+[country code] [area code] [number])

string

Not available when retrieving respondents for an anonymous survey

CountryId

ISO 3166-1 two-letter country code.

string

3/lookup/countries

Gender

Contact's gender.

string

Matching regular expression pattern: ^[m|M|f|F]$

DateOfBirth

Contact's birthday.

date

* ISO 8601 format * Not available when retrieving respondents for an anonymous survey

IsBounced

Indicates if the email address for this contact is currently on the bounce list.

boolean

IsOptedOut

Indicates if this contact is currently on the opt out list.

boolean

Surveys

A list of surveys to which a contact is linked. When retrieving a list of contacts, this property is by default not available. If you would like this additional information, you can use the expand parameter $expand=Surveys.

Collection of SurveyReference

Expandable

Groups

A list of groups to which a contact is linked. When retrieving a list of contacts, this property is by default not available. If you would like this additional information, you can use the expand parameter $expand=Groups.

Collection of GroupReference

Expandable

Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.

Hateoas

Related Methods

Verb Url Description
GET 3/contacts?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}

Retrieve all contacts which match the passed criteria

GET 3/contacts/{contactId}

Retrieve a contact by id.