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.

Name	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": "0ea502ad-8718-40fb-8e97-84b836f66abc",
  "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>0ea502ad-8718-40fb-8e97-84b836f66abc</TenantId>
  <Type>UserJourney</Type>
</UserJourneysFilterCriteriaDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of UserJourneyDto

Name	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": "6259204a-909d-4200-94d9-b4c8b60347d3",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
    "TenantId": "aa24ff35-5a56-4b0e-8237-6d56c9d2b048",
    "Type": 0,
    "SortIndex": 6,
    "UserJourneyProperties": [
      {
        "Id": "0c7d8ca8-0109-406f-9163-ef8ca86cee7a",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "UserJourneyId": "a7a28a01-3b51-48c2-a65d-df6e89aa8756"
      },
      {
        "Id": "0c7d8ca8-0109-406f-9163-ef8ca86cee7a",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "UserJourneyId": "a7a28a01-3b51-48c2-a65d-df6e89aa8756"
      }
    ],
    "ModuleSettings": [
      {
        "Id": "9b9ab701-b5b3-4768-95c2-83a4ac2badbe",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "TenantId": "7b782805-6b3b-4ebe-bab3-995a03dfb29f",
        "UserJourneyId": "d3421076-2887-4547-b6ad-ed4291bc786a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          },
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          }
        ]
      },
      {
        "Id": "9b9ab701-b5b3-4768-95c2-83a4ac2badbe",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "TenantId": "7b782805-6b3b-4ebe-bab3-995a03dfb29f",
        "UserJourneyId": "d3421076-2887-4547-b6ad-ed4291bc786a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          },
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          }
        ]
      }
    ]
  },
  {
    "Id": "6259204a-909d-4200-94d9-b4c8b60347d3",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
    "TenantId": "aa24ff35-5a56-4b0e-8237-6d56c9d2b048",
    "Type": 0,
    "SortIndex": 6,
    "UserJourneyProperties": [
      {
        "Id": "0c7d8ca8-0109-406f-9163-ef8ca86cee7a",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "UserJourneyId": "a7a28a01-3b51-48c2-a65d-df6e89aa8756"
      },
      {
        "Id": "0c7d8ca8-0109-406f-9163-ef8ca86cee7a",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "UserJourneyId": "a7a28a01-3b51-48c2-a65d-df6e89aa8756"
      }
    ],
    "ModuleSettings": [
      {
        "Id": "9b9ab701-b5b3-4768-95c2-83a4ac2badbe",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "TenantId": "7b782805-6b3b-4ebe-bab3-995a03dfb29f",
        "UserJourneyId": "d3421076-2887-4547-b6ad-ed4291bc786a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          },
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          }
        ]
      },
      {
        "Id": "9b9ab701-b5b3-4768-95c2-83a4ac2badbe",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
        "TenantId": "7b782805-6b3b-4ebe-bab3-995a03dfb29f",
        "UserJourneyId": "d3421076-2887-4547-b6ad-ed4291bc786a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          },
          {
            "Id": "4c4a3309-3c5d-4200-8890-c68a59cb832f",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T03:11:22.0797351+00:00",
            "ModuleSettingId": "785bd684-b66c-4d75-9b0d-4b01d6c5fa8b"
          }
        ]
      }
    ]
  }
]

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>2025-12-06T03:11:22.0797351+00:00</CreationDate>
    <DisplayName>sample string 3</DisplayName>
    <Id>6259204a-909d-4200-94d9-b4c8b60347d3</Id>
    <ModuleSettings>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>9b9ab701-b5b3-4768-95c2-83a4ac2badbe</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</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>7b782805-6b3b-4ebe-bab3-995a03dfb29f</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>d3421076-2887-4547-b6ad-ed4291bc786a</UserJourneyId>
      </ModuleSettingDto>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>9b9ab701-b5b3-4768-95c2-83a4ac2badbe</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</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>7b782805-6b3b-4ebe-bab3-995a03dfb29f</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>d3421076-2887-4547-b6ad-ed4291bc786a</UserJourneyId>
      </ModuleSettingDto>
    </ModuleSettings>
    <Name>sample string 2</Name>
    <SortIndex>6</SortIndex>
    <TenantId>aa24ff35-5a56-4b0e-8237-6d56c9d2b048</TenantId>
    <Type>UserJourney</Type>
    <UserJourneyProperties>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <Id>0c7d8ca8-0109-406f-9163-ef8ca86cee7a</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>a7a28a01-3b51-48c2-a65d-df6e89aa8756</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <Id>0c7d8ca8-0109-406f-9163-ef8ca86cee7a</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>a7a28a01-3b51-48c2-a65d-df6e89aa8756</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
    </UserJourneyProperties>
  </UserJourneyDto>
  <UserJourneyDto>
    <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
    <DisplayName>sample string 3</DisplayName>
    <Id>6259204a-909d-4200-94d9-b4c8b60347d3</Id>
    <ModuleSettings>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>9b9ab701-b5b3-4768-95c2-83a4ac2badbe</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</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>7b782805-6b3b-4ebe-bab3-995a03dfb29f</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>d3421076-2887-4547-b6ad-ed4291bc786a</UserJourneyId>
      </ModuleSettingDto>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>9b9ab701-b5b3-4768-95c2-83a4ac2badbe</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
            <Id>4c4a3309-3c5d-4200-8890-c68a59cb832f</Id>
            <ModuleSettingId>785bd684-b66c-4d75-9b0d-4b01d6c5fa8b</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>7b782805-6b3b-4ebe-bab3-995a03dfb29f</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>d3421076-2887-4547-b6ad-ed4291bc786a</UserJourneyId>
      </ModuleSettingDto>
    </ModuleSettings>
    <Name>sample string 2</Name>
    <SortIndex>6</SortIndex>
    <TenantId>aa24ff35-5a56-4b0e-8237-6d56c9d2b048</TenantId>
    <Type>UserJourney</Type>
    <UserJourneyProperties>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <Id>0c7d8ca8-0109-406f-9163-ef8ca86cee7a</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>a7a28a01-3b51-48c2-a65d-df6e89aa8756</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T03:11:22.0797351+00:00</CreationDate>
        <Id>0c7d8ca8-0109-406f-9163-ef8ca86cee7a</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>a7a28a01-3b51-48c2-a65d-df6e89aa8756</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
    </UserJourneyProperties>
  </UserJourneyDto>
</ArrayOfUserJourneyDto>