GET v1/contacts
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityId | integer |
None. |
|
| JointEntityId | integer |
None. |
|
| Name | Name |
None. |
|
| FirstName | string |
None. |
|
| MiddleName | string |
None. |
|
| LastName | string |
None. |
|
| DisplayName | string |
None. |
|
| DetailsId | integer |
None. |
|
| TaxId | string |
None. |
|
| Address | string |
None. |
|
| Zip | string |
None. |
|
| Phone | string |
None. |
|
| CaseId | integer |
None. |
|
| SearchAllRoles | boolean |
None. |
|
| Role | Role_Id |
None. |
|
| RoleGroup | RoleGroup_Id |
None. |
|
| Owner | string |
None. |
|
| entityType | Entity_Type |
None. |
|
| IncludePerson | boolean |
None. |
|
| IncludePersonName | boolean |
None. |
|
| IncludePreferredPhone | boolean |
None. |
|
| IncludePhoneForNotifications | boolean |
None. |
|
| IncludePreferredEmail | boolean |
None. |
|
| IncludePreferredAddress | boolean |
None. |
|
| IncludeAddressObject | boolean |
None. |
|
| IncludePreferredTaxId | boolean |
None. |
|
| IncludePrimaryRole | boolean |
None. |
|
| IncludeTracking | boolean |
None. |
|
| IncludeForNotifications | boolean |
None. |
|
| IncludeCaseData | boolean |
None. |
|
| IncludeUserData | boolean |
None. |
|
| IncludeLicenseData | boolean |
None. |
|
| RelatedDebtId | integer |
None. |
|
| RelationRoleId | integer |
None. |
|
| ContactsPeriod | ContactsFilter |
None. |
|
| OnlyContactsInParties | boolean |
None. |
|
| ParentEntitiesOnly | boolean |
None. |
|
| IncludeInactiveOnly | boolean |
None. |
|
| IncludeInactive | boolean |
None. |
|
| ExcludeEntityId | integer |
None. |
|
| ExcludeFirmRoles | boolean |
None. |
|
| SortByUsersFirst | boolean |
None. |
|
| ForCaseTransfer | boolean |
None. |
|
| columns | Collection of Column |
None. |
|
| order | Collection of SearchOrder |
None. |
|
| searchColumns | Collection of Column |
None. |
|
| search | RegExSearch |
None. |
|
| draw | integer |
None. |
|
| start | integer |
None. |
|
| length | integer |
None. |
|
| searchTerm | string |
None. |
|
| term | string |
None. |
|
| sortBy | string |
None. |
|
| sortDirection | string |
None. |
|
| ClientEntityId | integer |
None. |
|
| ForHost | boolean |
None. |
|
| ForSearch | boolean |
None. |
|
| ForSearchList | boolean |
None. |
|
| UseAzureSearch | boolean |
None. |
|
| VendorId | string |
None. |
|
| VendorType | Vendor_Type |
None. |
|
| IsExternal | boolean |
None. |
|
| IncludeExternal | boolean |
None. |
|
| IncludeExternalOnly | boolean |
None. |
|
| ExportToCSV | boolean |
None. |
|
| SearchTermConditionOption | SearchTermCondition_Option |
None. |
|
| SearchTermFilterType | SearchFilter_Type |
None. |
Body Parameters
None.
Response Information
Resource Description
SearchResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Draw | integer |
None. |
|
| RecordsTotal | integer |
None. |
|
| RecordsFiltered | integer |
None. |
|
| Data | Object |
None. |
|
| NextPageUrl | string |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.