POST {version}/GetContactFilters
Get Contact Filters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of Contact Filters
Collection of FilterName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
ExpressionId | globally unique identifier |
None. |
|
Description | string |
None. |
|
Internal | boolean |
None. |
|
Inactive | boolean |
None. |
|
CreatedOn | date |
None. |
|
UpdatedOn | date |
None. |
|
LastModifiedOn | date |
None. |
|
ToBeDeleted | boolean |
None. |
|
SubOptions | Collection of FilterOptionDefinitionSubOption |
None. |
|
Columns | Collection of FilterColumnAssociation |
None. |
|
DataFilter | string |
None. |
|
SortCol | string |
None. |
|
SortAsc | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "f8955726-40dd-4122-95b5-126cdf40fafd", "Name": "sample string 2", "ExpressionId": "5a7dfb0e-49b3-4ffa-9244-92257eceb09b", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "09/02/2025", "UpdatedOn": "09/02/2025", "LastModifiedOn": "09/02/2025", "ToBeDeleted": true, "SubOptions": [ { "Id": "2d7e53a0-44b4-453c-8d43-c773abafc856", "DefId": "5d19f017-fe7b-4e7e-95d9-62ed441875c1", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "2d7e53a0-44b4-453c-8d43-c773abafc856", "DefId": "5d19f017-fe7b-4e7e-95d9-62ed441875c1", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "05f6b0bd-b0fe-45ff-bc55-061c5851fff1", "FilterId": "2756b389-e38a-4b85-bfdc-6e865523aadf", "ColumnId": "c09e4400-5d19-4ff7-82e9-108ee45d35d2", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "05f6b0bd-b0fe-45ff-bc55-061c5851fff1", "FilterId": "2756b389-e38a-4b85-bfdc-6e865523aadf", "ColumnId": "c09e4400-5d19-4ff7-82e9-108ee45d35d2", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true }, { "Id": "f8955726-40dd-4122-95b5-126cdf40fafd", "Name": "sample string 2", "ExpressionId": "5a7dfb0e-49b3-4ffa-9244-92257eceb09b", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "09/02/2025", "UpdatedOn": "09/02/2025", "LastModifiedOn": "09/02/2025", "ToBeDeleted": true, "SubOptions": [ { "Id": "2d7e53a0-44b4-453c-8d43-c773abafc856", "DefId": "5d19f017-fe7b-4e7e-95d9-62ed441875c1", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "2d7e53a0-44b4-453c-8d43-c773abafc856", "DefId": "5d19f017-fe7b-4e7e-95d9-62ed441875c1", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "05f6b0bd-b0fe-45ff-bc55-061c5851fff1", "FilterId": "2756b389-e38a-4b85-bfdc-6e865523aadf", "ColumnId": "c09e4400-5d19-4ff7-82e9-108ee45d35d2", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "05f6b0bd-b0fe-45ff-bc55-061c5851fff1", "FilterId": "2756b389-e38a-4b85-bfdc-6e865523aadf", "ColumnId": "c09e4400-5d19-4ff7-82e9-108ee45d35d2", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true } ]
application/xml, text/xml
Sample:
<ArrayOfFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <Filter> <Columns> <FilterColumnAssociation> <ColumnId>c09e4400-5d19-4ff7-82e9-108ee45d35d2</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>2756b389-e38a-4b85-bfdc-6e865523aadf</FilterId> <Id>05f6b0bd-b0fe-45ff-bc55-061c5851fff1</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>c09e4400-5d19-4ff7-82e9-108ee45d35d2</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>2756b389-e38a-4b85-bfdc-6e865523aadf</FilterId> <Id>05f6b0bd-b0fe-45ff-bc55-061c5851fff1</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2025-09-02T05:15:41.9144635-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>5a7dfb0e-49b3-4ffa-9244-92257eceb09b</ExpressionId> <Id>f8955726-40dd-4122-95b5-126cdf40fafd</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>5d19f017-fe7b-4e7e-95d9-62ed441875c1</DefId> <Id>2d7e53a0-44b4-453c-8d43-c773abafc856</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>5d19f017-fe7b-4e7e-95d9-62ed441875c1</DefId> <Id>2d7e53a0-44b4-453c-8d43-c773abafc856</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> </SubOptions> <ToBeDeleted>true</ToBeDeleted> <UpdatedOn>2025-09-02T05:15:41.9144635-04:00</UpdatedOn> </Filter> <Filter> <Columns> <FilterColumnAssociation> <ColumnId>c09e4400-5d19-4ff7-82e9-108ee45d35d2</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>2756b389-e38a-4b85-bfdc-6e865523aadf</FilterId> <Id>05f6b0bd-b0fe-45ff-bc55-061c5851fff1</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>c09e4400-5d19-4ff7-82e9-108ee45d35d2</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>2756b389-e38a-4b85-bfdc-6e865523aadf</FilterId> <Id>05f6b0bd-b0fe-45ff-bc55-061c5851fff1</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2025-09-02T05:15:41.9144635-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>5a7dfb0e-49b3-4ffa-9244-92257eceb09b</ExpressionId> <Id>f8955726-40dd-4122-95b5-126cdf40fafd</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>5d19f017-fe7b-4e7e-95d9-62ed441875c1</DefId> <Id>2d7e53a0-44b4-453c-8d43-c773abafc856</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>5d19f017-fe7b-4e7e-95d9-62ed441875c1</DefId> <Id>2d7e53a0-44b4-453c-8d43-c773abafc856</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> </SubOptions> <ToBeDeleted>true</ToBeDeleted> <UpdatedOn>2025-09-02T05:15:41.9144635-04:00</UpdatedOn> </Filter> </ArrayOfFilter>