GET api/userJourneys/{id}

Retrieves a user journey.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the user journey to retrieve.	globally unique identifier	Required

Body Parameters

None.

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": "3cb43fa3-c1f7-49bd-8711-9aefc9f0e357",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "CreationDate": "2025-12-06T04:48:15.9496531+00:00",
    "TenantId": "63aec2e0-7017-4e50-a602-4a09b771d0d0",
    "Type": 0,
    "SortIndex": 6,
    "UserJourneyProperties": [
      {
        "Id": "092500b1-2a9a-46d3-8b45-429acac9360c",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "UserJourneyId": "d5ad8645-e4c2-4251-9bff-f83392eac707"
      },
      {
        "Id": "092500b1-2a9a-46d3-8b45-429acac9360c",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "UserJourneyId": "d5ad8645-e4c2-4251-9bff-f83392eac707"
      }
    ],
    "ModuleSettings": [
      {
        "Id": "5cfb30df-de82-43f3-a87a-c7315b589f12",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "TenantId": "1e06b93a-3515-4cf1-9aec-dc29dddc42ba",
        "UserJourneyId": "6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          },
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          }
        ]
      },
      {
        "Id": "5cfb30df-de82-43f3-a87a-c7315b589f12",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "TenantId": "1e06b93a-3515-4cf1-9aec-dc29dddc42ba",
        "UserJourneyId": "6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          },
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          }
        ]
      }
    ]
  },
  {
    "Id": "3cb43fa3-c1f7-49bd-8711-9aefc9f0e357",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "CreationDate": "2025-12-06T04:48:15.9496531+00:00",
    "TenantId": "63aec2e0-7017-4e50-a602-4a09b771d0d0",
    "Type": 0,
    "SortIndex": 6,
    "UserJourneyProperties": [
      {
        "Id": "092500b1-2a9a-46d3-8b45-429acac9360c",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "UserJourneyId": "d5ad8645-e4c2-4251-9bff-f83392eac707"
      },
      {
        "Id": "092500b1-2a9a-46d3-8b45-429acac9360c",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "UserJourneyId": "d5ad8645-e4c2-4251-9bff-f83392eac707"
      }
    ],
    "ModuleSettings": [
      {
        "Id": "5cfb30df-de82-43f3-a87a-c7315b589f12",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "TenantId": "1e06b93a-3515-4cf1-9aec-dc29dddc42ba",
        "UserJourneyId": "6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          },
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          }
        ]
      },
      {
        "Id": "5cfb30df-de82-43f3-a87a-c7315b589f12",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
        "TenantId": "1e06b93a-3515-4cf1-9aec-dc29dddc42ba",
        "UserJourneyId": "6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          },
          {
            "Id": "da3e7c67-444b-47e7-96d4-cf4dec0fbd32",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:15.9504249+00:00",
            "ModuleSettingId": "55690741-3f40-4b5b-933f-1f83f8673845"
          }
        ]
      }
    ]
  }
]

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-06T04:48:15.9496531+00:00</CreationDate>
    <DisplayName>sample string 3</DisplayName>
    <Id>3cb43fa3-c1f7-49bd-8711-9aefc9f0e357</Id>
    <ModuleSettings>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>5cfb30df-de82-43f3-a87a-c7315b589f12</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</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>1e06b93a-3515-4cf1-9aec-dc29dddc42ba</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a</UserJourneyId>
      </ModuleSettingDto>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>5cfb30df-de82-43f3-a87a-c7315b589f12</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</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>1e06b93a-3515-4cf1-9aec-dc29dddc42ba</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a</UserJourneyId>
      </ModuleSettingDto>
    </ModuleSettings>
    <Name>sample string 2</Name>
    <SortIndex>6</SortIndex>
    <TenantId>63aec2e0-7017-4e50-a602-4a09b771d0d0</TenantId>
    <Type>UserJourney</Type>
    <UserJourneyProperties>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <Id>092500b1-2a9a-46d3-8b45-429acac9360c</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>d5ad8645-e4c2-4251-9bff-f83392eac707</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <Id>092500b1-2a9a-46d3-8b45-429acac9360c</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>d5ad8645-e4c2-4251-9bff-f83392eac707</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
    </UserJourneyProperties>
  </UserJourneyDto>
  <UserJourneyDto>
    <CreationDate>2025-12-06T04:48:15.9496531+00:00</CreationDate>
    <DisplayName>sample string 3</DisplayName>
    <Id>3cb43fa3-c1f7-49bd-8711-9aefc9f0e357</Id>
    <ModuleSettings>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>5cfb30df-de82-43f3-a87a-c7315b589f12</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</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>1e06b93a-3515-4cf1-9aec-dc29dddc42ba</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a</UserJourneyId>
      </ModuleSettingDto>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>5cfb30df-de82-43f3-a87a-c7315b589f12</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
            <Id>da3e7c67-444b-47e7-96d4-cf4dec0fbd32</Id>
            <ModuleSettingId>55690741-3f40-4b5b-933f-1f83f8673845</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>1e06b93a-3515-4cf1-9aec-dc29dddc42ba</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>6506dad8-d1c9-4cbe-8e99-d84b0a3ec77a</UserJourneyId>
      </ModuleSettingDto>
    </ModuleSettings>
    <Name>sample string 2</Name>
    <SortIndex>6</SortIndex>
    <TenantId>63aec2e0-7017-4e50-a602-4a09b771d0d0</TenantId>
    <Type>UserJourney</Type>
    <UserJourneyProperties>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <Id>092500b1-2a9a-46d3-8b45-429acac9360c</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>d5ad8645-e4c2-4251-9bff-f83392eac707</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:15.9504249+00:00</CreationDate>
        <Id>092500b1-2a9a-46d3-8b45-429acac9360c</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>d5ad8645-e4c2-4251-9bff-f83392eac707</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
    </UserJourneyProperties>
  </UserJourneyDto>
</ArrayOfUserJourneyDto>