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": "9c2baeca-f2aa-46b9-890c-172ba448bfa3",
"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>9c2baeca-f2aa-46b9-890c-172ba448bfa3</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": "6dc5da5e-5467-4a69-ac98-1cce83253fb7",
"Name": "sample string 2",
"DisplayName": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"TenantId": "1e862d40-96a8-4a15-9d02-6bd783ea3de7",
"Type": 0,
"SortIndex": 6,
"UserJourneyProperties": [
{
"Id": "4f1de07c-3802-4255-9ce0-09d80a361112",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"UserJourneyId": "7a0fe2d6-a657-4495-ba2e-9a165d2879c8"
},
{
"Id": "4f1de07c-3802-4255-9ce0-09d80a361112",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"UserJourneyId": "7a0fe2d6-a657-4495-ba2e-9a165d2879c8"
}
],
"ModuleSettings": [
{
"Id": "8a69a1b9-ffa0-4a17-ba72-d04c07660396",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"TenantId": "742027a4-adf6-4274-9cc6-8e3a03db9597",
"UserJourneyId": "d62c8391-6635-46bf-9dcc-3075bff6dd70",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
},
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
}
]
},
{
"Id": "8a69a1b9-ffa0-4a17-ba72-d04c07660396",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"TenantId": "742027a4-adf6-4274-9cc6-8e3a03db9597",
"UserJourneyId": "d62c8391-6635-46bf-9dcc-3075bff6dd70",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
},
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
}
]
}
]
},
{
"Id": "6dc5da5e-5467-4a69-ac98-1cce83253fb7",
"Name": "sample string 2",
"DisplayName": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"TenantId": "1e862d40-96a8-4a15-9d02-6bd783ea3de7",
"Type": 0,
"SortIndex": 6,
"UserJourneyProperties": [
{
"Id": "4f1de07c-3802-4255-9ce0-09d80a361112",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"UserJourneyId": "7a0fe2d6-a657-4495-ba2e-9a165d2879c8"
},
{
"Id": "4f1de07c-3802-4255-9ce0-09d80a361112",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"UserJourneyId": "7a0fe2d6-a657-4495-ba2e-9a165d2879c8"
}
],
"ModuleSettings": [
{
"Id": "8a69a1b9-ffa0-4a17-ba72-d04c07660396",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"TenantId": "742027a4-adf6-4274-9cc6-8e3a03db9597",
"UserJourneyId": "d62c8391-6635-46bf-9dcc-3075bff6dd70",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
},
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
}
]
},
{
"Id": "8a69a1b9-ffa0-4a17-ba72-d04c07660396",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"TenantId": "742027a4-adf6-4274-9cc6-8e3a03db9597",
"UserJourneyId": "d62c8391-6635-46bf-9dcc-3075bff6dd70",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
},
{
"Id": "aadd66f1-d568-4f2b-b657-a3e4cf241eb9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:24:01.9539132+00:00",
"ModuleSettingId": "b09ed2de-7eaf-420f-a6b3-83ee488bd83e"
}
]
}
]
}
]
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-11T20:24:01.9539132+00:00</CreationDate>
<DisplayName>sample string 3</DisplayName>
<Id>6dc5da5e-5467-4a69-ac98-1cce83253fb7</Id>
<ModuleSettings>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>8a69a1b9-ffa0-4a17-ba72-d04c07660396</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</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>742027a4-adf6-4274-9cc6-8e3a03db9597</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>d62c8391-6635-46bf-9dcc-3075bff6dd70</UserJourneyId>
</ModuleSettingDto>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>8a69a1b9-ffa0-4a17-ba72-d04c07660396</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</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>742027a4-adf6-4274-9cc6-8e3a03db9597</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>d62c8391-6635-46bf-9dcc-3075bff6dd70</UserJourneyId>
</ModuleSettingDto>
</ModuleSettings>
<Name>sample string 2</Name>
<SortIndex>6</SortIndex>
<TenantId>1e862d40-96a8-4a15-9d02-6bd783ea3de7</TenantId>
<Type>UserJourney</Type>
<UserJourneyProperties>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>4f1de07c-3802-4255-9ce0-09d80a361112</Id>
<Name>sample string 2</Name>
<UserJourneyId>7a0fe2d6-a657-4495-ba2e-9a165d2879c8</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>4f1de07c-3802-4255-9ce0-09d80a361112</Id>
<Name>sample string 2</Name>
<UserJourneyId>7a0fe2d6-a657-4495-ba2e-9a165d2879c8</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
</UserJourneyProperties>
</UserJourneyDto>
<UserJourneyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<DisplayName>sample string 3</DisplayName>
<Id>6dc5da5e-5467-4a69-ac98-1cce83253fb7</Id>
<ModuleSettings>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>8a69a1b9-ffa0-4a17-ba72-d04c07660396</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</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>742027a4-adf6-4274-9cc6-8e3a03db9597</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>d62c8391-6635-46bf-9dcc-3075bff6dd70</UserJourneyId>
</ModuleSettingDto>
<ModuleSettingDto>
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>8a69a1b9-ffa0-4a17-ba72-d04c07660396</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>aadd66f1-d568-4f2b-b657-a3e4cf241eb9</Id>
<ModuleSettingId>b09ed2de-7eaf-420f-a6b3-83ee488bd83e</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>742027a4-adf6-4274-9cc6-8e3a03db9597</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>d62c8391-6635-46bf-9dcc-3075bff6dd70</UserJourneyId>
</ModuleSettingDto>
</ModuleSettings>
<Name>sample string 2</Name>
<SortIndex>6</SortIndex>
<TenantId>1e862d40-96a8-4a15-9d02-6bd783ea3de7</TenantId>
<Type>UserJourney</Type>
<UserJourneyProperties>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>4f1de07c-3802-4255-9ce0-09d80a361112</Id>
<Name>sample string 2</Name>
<UserJourneyId>7a0fe2d6-a657-4495-ba2e-9a165d2879c8</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
<UserJourneyPropertyDto>
<CreationDate>2026-01-11T20:24:01.9539132+00:00</CreationDate>
<Id>4f1de07c-3802-4255-9ce0-09d80a361112</Id>
<Name>sample string 2</Name>
<UserJourneyId>7a0fe2d6-a657-4495-ba2e-9a165d2879c8</UserJourneyId>
<Value>sample string 3</Value>
</UserJourneyPropertyDto>
</UserJourneyProperties>
</UserJourneyDto>
</ArrayOfUserJourneyDto>