GET api/userJourneys/tenant

Retrieves a list of user journeys for the tenant of the user making the request.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of UserJourneyDto
NameDescriptionTypeAdditional 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": "03c378f2-bd37-4ca8-91d9-2f986268be73",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
    "TenantId": "21fe2f43-cf96-4d44-b116-dd40457ed2e3",
    "Type": 0,
    "SortIndex": 6,
    "UserJourneyProperties": [
      {
        "Id": "baf89533-bfc9-45f9-8743-bc139110acfd",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "UserJourneyId": "68ca19f2-3885-439f-89b1-f4f1c09463cb"
      },
      {
        "Id": "baf89533-bfc9-45f9-8743-bc139110acfd",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "UserJourneyId": "68ca19f2-3885-439f-89b1-f4f1c09463cb"
      }
    ],
    "ModuleSettings": [
      {
        "Id": "93c0e848-e098-4926-a02c-4aa3e985a239",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "TenantId": "77096666-23e3-4217-859b-a59bfee77a66",
        "UserJourneyId": "e571090d-bbae-44bc-8017-361390972ab1",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          },
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          }
        ]
      },
      {
        "Id": "93c0e848-e098-4926-a02c-4aa3e985a239",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "TenantId": "77096666-23e3-4217-859b-a59bfee77a66",
        "UserJourneyId": "e571090d-bbae-44bc-8017-361390972ab1",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          },
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          }
        ]
      }
    ]
  },
  {
    "Id": "03c378f2-bd37-4ca8-91d9-2f986268be73",
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
    "TenantId": "21fe2f43-cf96-4d44-b116-dd40457ed2e3",
    "Type": 0,
    "SortIndex": 6,
    "UserJourneyProperties": [
      {
        "Id": "baf89533-bfc9-45f9-8743-bc139110acfd",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "UserJourneyId": "68ca19f2-3885-439f-89b1-f4f1c09463cb"
      },
      {
        "Id": "baf89533-bfc9-45f9-8743-bc139110acfd",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "UserJourneyId": "68ca19f2-3885-439f-89b1-f4f1c09463cb"
      }
    ],
    "ModuleSettings": [
      {
        "Id": "93c0e848-e098-4926-a02c-4aa3e985a239",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "TenantId": "77096666-23e3-4217-859b-a59bfee77a66",
        "UserJourneyId": "e571090d-bbae-44bc-8017-361390972ab1",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          },
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          }
        ]
      },
      {
        "Id": "93c0e848-e098-4926-a02c-4aa3e985a239",
        "Name": "sample string 2",
        "Url": "sample string 3",
        "DisplayName": "sample string 4",
        "ServiceType": 0,
        "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
        "TenantId": "77096666-23e3-4217-859b-a59bfee77a66",
        "UserJourneyId": "e571090d-bbae-44bc-8017-361390972ab1",
        "Bypassable": true,
        "DefaultValue": "sample string 9",
        "SortIndex": 10,
        "ModuleSettingProperties": [
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          },
          {
            "Id": "4f5234e4-4d17-4fb7-97fc-1e26048a4408",
            "Name": "sample string 2",
            "Value": "sample string 3",
            "CreationDate": "2025-12-06T04:48:30.5024569+00:00",
            "ModuleSettingId": "19ba7081-4940-4c36-aeaf-49c4306a40b7"
          }
        ]
      }
    ]
  }
]

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:30.5024569+00:00</CreationDate>
    <DisplayName>sample string 3</DisplayName>
    <Id>03c378f2-bd37-4ca8-91d9-2f986268be73</Id>
    <ModuleSettings>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>93c0e848-e098-4926-a02c-4aa3e985a239</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</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>77096666-23e3-4217-859b-a59bfee77a66</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>e571090d-bbae-44bc-8017-361390972ab1</UserJourneyId>
      </ModuleSettingDto>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>93c0e848-e098-4926-a02c-4aa3e985a239</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</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>77096666-23e3-4217-859b-a59bfee77a66</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>e571090d-bbae-44bc-8017-361390972ab1</UserJourneyId>
      </ModuleSettingDto>
    </ModuleSettings>
    <Name>sample string 2</Name>
    <SortIndex>6</SortIndex>
    <TenantId>21fe2f43-cf96-4d44-b116-dd40457ed2e3</TenantId>
    <Type>UserJourney</Type>
    <UserJourneyProperties>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <Id>baf89533-bfc9-45f9-8743-bc139110acfd</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>68ca19f2-3885-439f-89b1-f4f1c09463cb</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <Id>baf89533-bfc9-45f9-8743-bc139110acfd</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>68ca19f2-3885-439f-89b1-f4f1c09463cb</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
    </UserJourneyProperties>
  </UserJourneyDto>
  <UserJourneyDto>
    <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
    <DisplayName>sample string 3</DisplayName>
    <Id>03c378f2-bd37-4ca8-91d9-2f986268be73</Id>
    <ModuleSettings>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>93c0e848-e098-4926-a02c-4aa3e985a239</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</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>77096666-23e3-4217-859b-a59bfee77a66</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>e571090d-bbae-44bc-8017-361390972ab1</UserJourneyId>
      </ModuleSettingDto>
      <ModuleSettingDto>
        <Bypassable>true</Bypassable>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <DefaultValue>sample string 9</DefaultValue>
        <DisplayName>sample string 4</DisplayName>
        <Id>93c0e848-e098-4926-a02c-4aa3e985a239</Id>
        <ModuleSettingProperties>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</ModuleSettingId>
            <Name>sample string 2</Name>
            <Value>sample string 3</Value>
          </ModuleSettingPropertyDto>
          <ModuleSettingPropertyDto>
            <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
            <Id>4f5234e4-4d17-4fb7-97fc-1e26048a4408</Id>
            <ModuleSettingId>19ba7081-4940-4c36-aeaf-49c4306a40b7</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>77096666-23e3-4217-859b-a59bfee77a66</TenantId>
        <Url>sample string 3</Url>
        <UserJourneyId>e571090d-bbae-44bc-8017-361390972ab1</UserJourneyId>
      </ModuleSettingDto>
    </ModuleSettings>
    <Name>sample string 2</Name>
    <SortIndex>6</SortIndex>
    <TenantId>21fe2f43-cf96-4d44-b116-dd40457ed2e3</TenantId>
    <Type>UserJourney</Type>
    <UserJourneyProperties>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <Id>baf89533-bfc9-45f9-8743-bc139110acfd</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>68ca19f2-3885-439f-89b1-f4f1c09463cb</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
      <UserJourneyPropertyDto>
        <CreationDate>2025-12-06T04:48:30.5024569+00:00</CreationDate>
        <Id>baf89533-bfc9-45f9-8743-bc139110acfd</Id>
        <Name>sample string 2</Name>
        <UserJourneyId>68ca19f2-3885-439f-89b1-f4f1c09463cb</UserJourneyId>
        <Value>sample string 3</Value>
      </UserJourneyPropertyDto>
    </UserJourneyProperties>
  </UserJourneyDto>
</ArrayOfUserJourneyDto>