GET Contacts/Contact
Get contacts
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
ContactIDs |
Filter by ContactID |
Collection of integer |
None. |
Type |
Filter by Type |
ContactType |
None. |
TypeEntries |
Filter by Type Entries |
Collection of integer |
None. |
Area |
Filter by Area |
string |
None. |
Gender |
Filter by Gender |
string |
None. |
MaritalStatus |
Filter by MaritalStatus |
string |
None. |
OrganizationName |
Filter by OrganizationName |
string |
None. |
JobTitle |
Filter by JobTitle |
string |
None. |
Comments |
Filter by Comments |
string |
None. |
BirthDateMin |
Filter by BirthDateMin |
date |
None. |
BirthDateMax |
Filter by BirthDateMax |
date |
None. |
IsBirthDateEstimated |
Filter by IsBirthDateEstimated |
boolean |
None. |
BirthMonth |
Filter by BirthMonth |
byte |
None. |
BirthDay |
Filter by BirthDay |
byte |
None. |
BirthCountryCode |
Filter by BirthCountryCode |
string |
None. |
TZIDEntryID |
Filter by TZIDEntryID |
integer |
None. |
WindowsTZEntryID |
Filter by WindowsTZEntryID |
integer |
None. |
Name |
Filter by Name |
NameDTO |
None. |
EntityID |
Filter by EntityID |
integer |
None. |
CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
BUCreatedDateUtcMin |
Filter by Business Unit's CreatedDateUtcMin |
date |
None. |
BUCreatedDateUtcMax |
Filter by Business Unit's CreatedDateUtcMax |
date |
None. |
LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
BULastUpdatedDateUtcMin |
Filter by Business Unit's LastUpdatedDateUtcMin |
date |
None. |
BULastUpdatedDateUtcMax |
Filter by Business Unit's LastUpdatedDateUtcMax |
date |
None. |
BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
BusinessUnitStatuses |
Filter by BusinessUnitStatuses |
Collection of integer |
None. |
Fields |
Filter by Fields |
Collection of FindExtensionCriteria |
None. |
IncludeBinaries |
Filter by Include Binaries |
boolean |
None. |
EntityUserChangeLastUpdatedDateUtcMin |
Filter by EntityUserChangeLastUpdatedOnMin |
date |
None. |
EntityUserChangeCodes |
Filter by EntityUserChangeCodes |
Collection of string |
None. |
Global |
Is Global |
boolean |
None. |
PartialDataType |
Only return partial data to speed up call (results cannot be used for add/update) PartialDataType.LightData should be suitable for display of basic Contact info in a list PartialDataType.MediumData will be treated as equivalent to PartialDataType.LightData |
PartialDataType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ContactDTOs
Collection of ContactDTOName | Description | Type | Additional information |
---|---|---|---|
ContactID |
A direct mapping to EntityID |
integer |
None. |
ContactType |
The Contact Type of the Contact, be it Gobal, Personal, or Business . |
ContactType |
None. |
ContactTypeEntryID |
The unique identifier of the Contact's Contact Type. Input from code table entries where TableName is "Contact Types", (). |
integer |
None. |
ContactTypeEntryValue |
The Name of the Contact's Contact Type. Input from code table entries where TableName is "Contact Types", (). |
string |
None. |
Area |
The Contact's Area. Input from code table entries where TableName is "Area", (). |
string |
None. |
Name |
The Contact's Name including prefix and suffix, . |
NameDTO |
None. |
Addresses |
A List of the Contact's Addresses . |
AddressesDTO |
None. |
BusinessUnits |
A list of links between this Contact and Business units . |
Collection of ContactBusinessUnitDTO |
None. |
CommunicationMethods |
A list of Communication method information for this Contact . |
CommunicationMethodsDTO |
None. |
OrganizationName |
The name of the Organization this Contact is associated with. |
string |
None. |
JobTitle |
The Job Title for the Contact. Input from code table entries where TableName is "Job Titles", (). |
string |
None. |
MaritalStatus |
The Marital Status of the Contact. Input from code table entries where TableName is "Marital Statuses", (). |
string |
None. |
Gender |
The Contact's Gender. Input from code table entries where TableName is "Genders", (). |
string |
None. |
BirthDate |
The Contact's Birth Date . |
date |
None. |
IsBirthDateEstimated |
Is the Birth Date specified for the Contact estimated. |
boolean |
None. |
BirthMonth |
The numerical Birth Month of the Contact. |
byte |
None. |
BirthDay |
The numerical Birth Day of the Contact. |
byte |
None. |
BirthCountryCode |
Birth Country Code. |
string |
None. |
TZIDEntryID |
The Timezone of the Contact. Input from code table entries where TableName is "Timezones (TZID)", (). |
integer |
None. |
WindowsTZEntryID |
The Windows Timezone for the Contact. |
integer |
None. |
Props |
Additional properties for the Contact record. . |
Collection of Object |
None. |
Comments |
Comments associated with the Contact. |
string |
None. |
RecordState |
The Record state of the Contact. |
RecordState |
None. |
Created |
The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly. |
AuditDataDTO |
None. |
LastUpdated |
The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly. |
AuditDataDTO |
None. |
Notifications |
A (potential) list of Notifications attached to the Contact . |
Collection of ContactNotificationDTO |
None. |
Extensions |
A (potential) list of additional data from extension forms attached to the Contact . |
Collection of FormDataExtensionDto |
None. |
PartialData | PartialDataType |
None. |
|
Summary |
The Summary of the Contact's Name field, . This field is readonly. |
string |
None. |
ImageExists |
Is there an image for the Contact. |
boolean |
None. |
ImageEntityFileID |
A Link to the Image Entity File ID using it's unique identifier. |
integer |
None. |
ImageEntityFileKey |
A key used to identify the EntityImageFile when using the Contacts/File/ViaKey/{key?}/{resultAtBased64:bool?} endpoint. |
string |
None. |
ImageEntityFileDateUtc |
The audit information for the ImageEntityFile, namely the creation date in UTC . |
date |
None. |
ImageEntityFileLastUpdatedDateUtc |
The audit information for the ImageEntityFile, namely the timestamp of the last update in UTC . |
date |
None. |
Global |
Is the Contact Global. |
boolean |
None. |