POST api/userJourneys/select
Retrieves a list of user journeys that match the given criteria.
Request Information
URI Parameters
None.
Body Parameters
The criteria model to filter user journeys by.
UserJourneysFilterCriteriaDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| Type | UserJourneyTypeDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"TenantId": "50c7e39b-2e4c-42f0-abc8-91b901b39f86",
"Type": 0
}
application/xml, text/xml
Sample:
<UserJourneysFilterCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models.FilterCriteria"> <Name>sample string 1</Name> <TenantId>50c7e39b-2e4c-42f0-abc8-91b901b39f86</TenantId> <Type>UserJourney</Type> </UserJourneysFilterCriteriaDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of UserJourneyDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
Required |
|
| DisplayName | string |
Required |
|
| CreationDate | date |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| Type | UserJourneyTypeDto |
None. |
|
| SortIndex | integer |
None. |
|
| UserJourneyProperties | Collection of UserJourneyPropertyDto |
None. |
|
| ModuleSettings | Collection of ModuleSettingDto |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "8edf07a6-0fd4-4077-90ec-6bcba8617f89",
"Name": "sample string 2",
"DisplayName": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"TenantId": "535792fd-5166-42e5-b55f-b0f7d59f0b5a",
"Type": 0,
"SortIndex": 6,
"UserJourneyProperties": [
{
"Id": "20804ce0-c01e-4ad0-ad19-9f4619aba946",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"UserJourneyId": "483c67a8-a01a-4a74-a04e-75d696e3b661"
},
{
"Id": "20804ce0-c01e-4ad0-ad19-9f4619aba946",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"UserJourneyId": "483c67a8-a01a-4a74-a04e-75d696e3b661"
}
],
"ModuleSettings": [
{
"Id": "6dd1f085-c4c5-46de-a27a-161888ea61ee",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"TenantId": "ea53fbf7-aed8-4adf-afa8-3717c052f04f",
"UserJourneyId": "ead4a3bf-3ee1-45b8-91a9-926154b6ebf1",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
},
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
}
]
},
{
"Id": "6dd1f085-c4c5-46de-a27a-161888ea61ee",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"TenantId": "ea53fbf7-aed8-4adf-afa8-3717c052f04f",
"UserJourneyId": "ead4a3bf-3ee1-45b8-91a9-926154b6ebf1",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
},
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
}
]
}
]
},
{
"Id": "8edf07a6-0fd4-4077-90ec-6bcba8617f89",
"Name": "sample string 2",
"DisplayName": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"TenantId": "535792fd-5166-42e5-b55f-b0f7d59f0b5a",
"Type": 0,
"SortIndex": 6,
"UserJourneyProperties": [
{
"Id": "20804ce0-c01e-4ad0-ad19-9f4619aba946",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"UserJourneyId": "483c67a8-a01a-4a74-a04e-75d696e3b661"
},
{
"Id": "20804ce0-c01e-4ad0-ad19-9f4619aba946",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"UserJourneyId": "483c67a8-a01a-4a74-a04e-75d696e3b661"
}
],
"ModuleSettings": [
{
"Id": "6dd1f085-c4c5-46de-a27a-161888ea61ee",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"TenantId": "ea53fbf7-aed8-4adf-afa8-3717c052f04f",
"UserJourneyId": "ead4a3bf-3ee1-45b8-91a9-926154b6ebf1",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
},
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
}
]
},
{
"Id": "6dd1f085-c4c5-46de-a27a-161888ea61ee",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"TenantId": "ea53fbf7-aed8-4adf-afa8-3717c052f04f",
"UserJourneyId": "ead4a3bf-3ee1-45b8-91a9-926154b6ebf1",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
},
{
"Id": "6b936a53-7642-4a67-8704-8346f457cd28",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T21:03:18.9132124+00:00",
"ModuleSettingId": "6c61a202-43a6-4db2-9b48-0ba93af6c324"
}
]
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfUserJourneyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models">
<UserJourneyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<DisplayName>sample string 3</DisplayName>
<Id>8edf07a6-0fd4-4077-90ec-6bcba8617f89</Id>
<ModuleSettings>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>6dd1f085-c4c5-46de-a27a-161888ea61ee</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
</ModuleSettingProperties>
<Name>sample string 2</Name>
<ServiceType>None</ServiceType>
<SortIndex>10</SortIndex>
<TenantId>ea53fbf7-aed8-4adf-afa8-3717c052f04f</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>ead4a3bf-3ee1-45b8-91a9-926154b6ebf1</UserJourneyId>
</ModuleSettingDto>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>6dd1f085-c4c5-46de-a27a-161888ea61ee</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
</ModuleSettingProperties>
<Name>sample string 2</Name>
<ServiceType>None</ServiceType>
<SortIndex>10</SortIndex>
<TenantId>ea53fbf7-aed8-4adf-afa8-3717c052f04f</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>ead4a3bf-3ee1-45b8-91a9-926154b6ebf1</UserJourneyId>
</ModuleSettingDto>
</ModuleSettings>
<Name>sample string 2</Name>
<SortIndex>6</SortIndex>
<TenantId>535792fd-5166-42e5-b55f-b0f7d59f0b5a</TenantId>
<Type>UserJourney</Type>
<UserJourneyProperties>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>20804ce0-c01e-4ad0-ad19-9f4619aba946</Id>
<Name>sample string 2</Name>
<UserJourneyId>483c67a8-a01a-4a74-a04e-75d696e3b661</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>20804ce0-c01e-4ad0-ad19-9f4619aba946</Id>
<Name>sample string 2</Name>
<UserJourneyId>483c67a8-a01a-4a74-a04e-75d696e3b661</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
</UserJourneyProperties>
</UserJourneyDto>
<UserJourneyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<DisplayName>sample string 3</DisplayName>
<Id>8edf07a6-0fd4-4077-90ec-6bcba8617f89</Id>
<ModuleSettings>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>6dd1f085-c4c5-46de-a27a-161888ea61ee</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
</ModuleSettingProperties>
<Name>sample string 2</Name>
<ServiceType>None</ServiceType>
<SortIndex>10</SortIndex>
<TenantId>ea53fbf7-aed8-4adf-afa8-3717c052f04f</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>ead4a3bf-3ee1-45b8-91a9-926154b6ebf1</UserJourneyId>
</ModuleSettingDto>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>6dd1f085-c4c5-46de-a27a-161888ea61ee</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>6b936a53-7642-4a67-8704-8346f457cd28</Id>
<ModuleSettingId>6c61a202-43a6-4db2-9b48-0ba93af6c324</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
</ModuleSettingProperties>
<Name>sample string 2</Name>
<ServiceType>None</ServiceType>
<SortIndex>10</SortIndex>
<TenantId>ea53fbf7-aed8-4adf-afa8-3717c052f04f</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>ead4a3bf-3ee1-45b8-91a9-926154b6ebf1</UserJourneyId>
</ModuleSettingDto>
</ModuleSettings>
<Name>sample string 2</Name>
<SortIndex>6</SortIndex>
<TenantId>535792fd-5166-42e5-b55f-b0f7d59f0b5a</TenantId>
<Type>UserJourney</Type>
<UserJourneyProperties>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>20804ce0-c01e-4ad0-ad19-9f4619aba946</Id>
<Name>sample string 2</Name>
<UserJourneyId>483c67a8-a01a-4a74-a04e-75d696e3b661</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T21:03:18.9132124+00:00</CreationDate>
<Id>20804ce0-c01e-4ad0-ad19-9f4619aba946</Id>
<Name>sample string 2</Name>
<UserJourneyId>483c67a8-a01a-4a74-a04e-75d696e3b661</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
</UserJourneyProperties>
</UserJourneyDto>
</ArrayOfUserJourneyDto>