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 ContactDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ContactID |
ID for Contact (maps to EntityID) |
integer |
None. |
| ContactType |
Contact Type |
ContactType |
None. |
| ContactTypeEntryID |
Contact Type Entry ID |
integer |
None. |
| ContactTypeEntryValue |
Contact Type Entry Name |
string |
None. |
| Area |
Area |
string |
None. |
| Name |
Name |
NameDTO |
None. |
| Addresses |
Addresses |
AddressesDTO |
None. |
| BusinessUnits |
Business units |
Collection of ContactBusinessUnitDTO |
None. |
| CommunicationMethods |
Communication methods |
CommunicationMethodsDTO |
None. |
| OrganizationName |
Organization Name |
string |
None. |
| JobTitle |
Job Title |
string |
None. |
| MaritalStatus |
Marital Status |
string |
None. |
| Gender |
Gender |
string |
None. |
| BirthDate |
Birth Date |
date |
None. |
| IsBirthDateEstimated |
Is Birth Date Estimated |
boolean |
None. |
| BirthMonth |
Birth Month |
byte |
None. |
| BirthDay |
Birth Day |
byte |
None. |
| BirthCountryCode |
Birth Country Code |
string |
None. |
| TZIDEntryID |
Timezone (TZID) |
integer |
None. |
| WindowsTZEntryID |
Timezone (Windows) |
integer |
None. |
| Props |
Generic properties |
Collection of Object |
None. |
| Comments |
Comments |
string |
None. |
| RecordState |
Record state |
RecordState |
None. |
| Created |
Date and user that created record |
AuditDataDTO |
None. |
| LastUpdated |
Date and user that last updated record |
AuditDataDTO |
None. |
| Notifications |
Notification attached to contact |
Collection of ContactNotificationDTO |
None. |
| Extensions |
Extensions |
Collection of FormDataExtensionDto |
None. |
| PartialData | PartialDataType |
None. |
|
| Summary |
Summarized information |
string |
None. |
| ImageExists |
Current Image Entity File ID |
boolean |
None. |
| ImageEntityFileID |
Image Entity File ID |
integer |
None. |
| ImageEntityFileKey |
Image Entity File Key |
string |
None. |
| ImageEntityFileDateUtc |
Image Entity File Date |
date |
None. |
| ImageEntityFileLastUpdatedDateUtc |
Image Entity File Last Updated Date |
date |
None. |
| Global | boolean |
None. |