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 Filter| Name | 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": "3a67a216-dba2-4a35-9212-2ccb5be93760",
"Name": "sample string 2",
"ExpressionId": "a54eec9d-3e96-4eb4-b300-6973660a9795",
"Description": "sample string 3",
"Internal": true,
"Inactive": true,
"CreatedOn": "01/27/2026",
"UpdatedOn": "01/27/2026",
"LastModifiedOn": "01/27/2026",
"ToBeDeleted": true,
"SubOptions": [
{
"Id": "bd242de9-0d97-4c69-82d6-e0e64f7b9387",
"DefId": "7289681d-2ed2-462b-84bc-e5016a556ecd",
"Type": "sample string 3",
"Text": "sample string 4",
"SelectedValue": "sample string 5",
"Order": 6
},
{
"Id": "bd242de9-0d97-4c69-82d6-e0e64f7b9387",
"DefId": "7289681d-2ed2-462b-84bc-e5016a556ecd",
"Type": "sample string 3",
"Text": "sample string 4",
"SelectedValue": "sample string 5",
"Order": 6
}
],
"Columns": [
{
"Id": "1876d28a-7698-4627-99da-0b5a0ca52ac1",
"FilterId": "849a0db3-9801-4ad5-b5c1-ea95652c7112",
"ColumnId": "82efd105-de60-41a1-aa68-4bc31ef29a69",
"Order": 4,
"DynamicId": "sample string 5"
},
{
"Id": "1876d28a-7698-4627-99da-0b5a0ca52ac1",
"FilterId": "849a0db3-9801-4ad5-b5c1-ea95652c7112",
"ColumnId": "82efd105-de60-41a1-aa68-4bc31ef29a69",
"Order": 4,
"DynamicId": "sample string 5"
}
],
"DataFilter": "sample string 8",
"SortCol": "sample string 9",
"SortAsc": true
},
{
"Id": "3a67a216-dba2-4a35-9212-2ccb5be93760",
"Name": "sample string 2",
"ExpressionId": "a54eec9d-3e96-4eb4-b300-6973660a9795",
"Description": "sample string 3",
"Internal": true,
"Inactive": true,
"CreatedOn": "01/27/2026",
"UpdatedOn": "01/27/2026",
"LastModifiedOn": "01/27/2026",
"ToBeDeleted": true,
"SubOptions": [
{
"Id": "bd242de9-0d97-4c69-82d6-e0e64f7b9387",
"DefId": "7289681d-2ed2-462b-84bc-e5016a556ecd",
"Type": "sample string 3",
"Text": "sample string 4",
"SelectedValue": "sample string 5",
"Order": 6
},
{
"Id": "bd242de9-0d97-4c69-82d6-e0e64f7b9387",
"DefId": "7289681d-2ed2-462b-84bc-e5016a556ecd",
"Type": "sample string 3",
"Text": "sample string 4",
"SelectedValue": "sample string 5",
"Order": 6
}
],
"Columns": [
{
"Id": "1876d28a-7698-4627-99da-0b5a0ca52ac1",
"FilterId": "849a0db3-9801-4ad5-b5c1-ea95652c7112",
"ColumnId": "82efd105-de60-41a1-aa68-4bc31ef29a69",
"Order": 4,
"DynamicId": "sample string 5"
},
{
"Id": "1876d28a-7698-4627-99da-0b5a0ca52ac1",
"FilterId": "849a0db3-9801-4ad5-b5c1-ea95652c7112",
"ColumnId": "82efd105-de60-41a1-aa68-4bc31ef29a69",
"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>82efd105-de60-41a1-aa68-4bc31ef29a69</ColumnId>
<DynamicId>sample string 5</DynamicId>
<FilterId>849a0db3-9801-4ad5-b5c1-ea95652c7112</FilterId>
<Id>1876d28a-7698-4627-99da-0b5a0ca52ac1</Id>
<Order>4</Order>
</FilterColumnAssociation>
<FilterColumnAssociation>
<ColumnId>82efd105-de60-41a1-aa68-4bc31ef29a69</ColumnId>
<DynamicId>sample string 5</DynamicId>
<FilterId>849a0db3-9801-4ad5-b5c1-ea95652c7112</FilterId>
<Id>1876d28a-7698-4627-99da-0b5a0ca52ac1</Id>
<Order>4</Order>
</FilterColumnAssociation>
</Columns>
<CreatedOn>2026-01-27T00:25:31.8688526-05:00</CreatedOn>
<DataFilter>sample string 8</DataFilter>
<Description>sample string 3</Description>
<ExpressionId>a54eec9d-3e96-4eb4-b300-6973660a9795</ExpressionId>
<Id>3a67a216-dba2-4a35-9212-2ccb5be93760</Id>
<Inactive>true</Inactive>
<Internal>true</Internal>
<Name>sample string 2</Name>
<SortAsc>true</SortAsc>
<SortCol>sample string 9</SortCol>
<SubOptions>
<FilterOptionDefinitionSubOption>
<DefId>7289681d-2ed2-462b-84bc-e5016a556ecd</DefId>
<Id>bd242de9-0d97-4c69-82d6-e0e64f7b9387</Id>
<Order>6</Order>
<SelectedValue>sample string 5</SelectedValue>
<Text>sample string 4</Text>
<Type>sample string 3</Type>
</FilterOptionDefinitionSubOption>
<FilterOptionDefinitionSubOption>
<DefId>7289681d-2ed2-462b-84bc-e5016a556ecd</DefId>
<Id>bd242de9-0d97-4c69-82d6-e0e64f7b9387</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>2026-01-27T00:25:31.8688526-05:00</UpdatedOn>
</Filter>
<Filter>
<Columns>
<FilterColumnAssociation>
<ColumnId>82efd105-de60-41a1-aa68-4bc31ef29a69</ColumnId>
<DynamicId>sample string 5</DynamicId>
<FilterId>849a0db3-9801-4ad5-b5c1-ea95652c7112</FilterId>
<Id>1876d28a-7698-4627-99da-0b5a0ca52ac1</Id>
<Order>4</Order>
</FilterColumnAssociation>
<FilterColumnAssociation>
<ColumnId>82efd105-de60-41a1-aa68-4bc31ef29a69</ColumnId>
<DynamicId>sample string 5</DynamicId>
<FilterId>849a0db3-9801-4ad5-b5c1-ea95652c7112</FilterId>
<Id>1876d28a-7698-4627-99da-0b5a0ca52ac1</Id>
<Order>4</Order>
</FilterColumnAssociation>
</Columns>
<CreatedOn>2026-01-27T00:25:31.8688526-05:00</CreatedOn>
<DataFilter>sample string 8</DataFilter>
<Description>sample string 3</Description>
<ExpressionId>a54eec9d-3e96-4eb4-b300-6973660a9795</ExpressionId>
<Id>3a67a216-dba2-4a35-9212-2ccb5be93760</Id>
<Inactive>true</Inactive>
<Internal>true</Internal>
<Name>sample string 2</Name>
<SortAsc>true</SortAsc>
<SortCol>sample string 9</SortCol>
<SubOptions>
<FilterOptionDefinitionSubOption>
<DefId>7289681d-2ed2-462b-84bc-e5016a556ecd</DefId>
<Id>bd242de9-0d97-4c69-82d6-e0e64f7b9387</Id>
<Order>6</Order>
<SelectedValue>sample string 5</SelectedValue>
<Text>sample string 4</Text>
<Type>sample string 3</Type>
</FilterOptionDefinitionSubOption>
<FilterOptionDefinitionSubOption>
<DefId>7289681d-2ed2-462b-84bc-e5016a556ecd</DefId>
<Id>bd242de9-0d97-4c69-82d6-e0e64f7b9387</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>2026-01-27T00:25:31.8688526-05:00</UpdatedOn>
</Filter>
</ArrayOfFilter>