GET api/moduleSettings

Retrieves a list of module settings.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ModuleSettingDto

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required
Url	string	Required
DisplayName	string	Required
ServiceType	ModuleSettingServiceTypeDto	None.
CreationDate	date	None.
TenantId	globally unique identifier	None.
UserJourneyId	globally unique identifier	None.
Bypassable	boolean	None.
DefaultValue	string	None.
SortIndex	integer	None.
ModuleSettingProperties	Collection of ModuleSettingPropertyDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "a2f02685-7302-4bfa-9596-eeb30c917d0b",
  "Name": "sample string 2",
  "Url": "sample string 3",
  "DisplayName": "sample string 4",
  "ServiceType": 0,
  "CreationDate": "2025-12-06T03:11:23.1302453+00:00",
  "TenantId": "a7739abb-e7fc-4563-a9f4-f4fa043d7ad8",
  "UserJourneyId": "88180bd8-9c91-40ea-8121-7fbc44adc8e8",
  "Bypassable": true,
  "DefaultValue": "sample string 9",
  "SortIndex": 10,
  "ModuleSettingProperties": [
    {
      "Id": "7d596ae4-8b03-471d-8dd2-2ba7e793ab85",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2025-12-06T03:11:23.1302453+00:00",
      "ModuleSettingId": "f4ffc90d-300c-4c41-9648-97f37de4c777"
    },
    {
      "Id": "7d596ae4-8b03-471d-8dd2-2ba7e793ab85",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2025-12-06T03:11:23.1302453+00:00",
      "ModuleSettingId": "f4ffc90d-300c-4c41-9648-97f37de4c777"
    }
  ]
}

application/xml, text/xml

Sample:

<ModuleSettingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models">
  <Bypassable>true</Bypassable>
  <CreationDate>2025-12-06T03:11:23.1302453+00:00</CreationDate>
  <DefaultValue>sample string 9</DefaultValue>
  <DisplayName>sample string 4</DisplayName>
  <Id>a2f02685-7302-4bfa-9596-eeb30c917d0b</Id>
  <ModuleSettingProperties>
    <ModuleSettingPropertyDto>
      <CreationDate>2025-12-06T03:11:23.1302453+00:00</CreationDate>
      <Id>7d596ae4-8b03-471d-8dd2-2ba7e793ab85</Id>
      <ModuleSettingId>f4ffc90d-300c-4c41-9648-97f37de4c777</ModuleSettingId>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </ModuleSettingPropertyDto>
    <ModuleSettingPropertyDto>
      <CreationDate>2025-12-06T03:11:23.1302453+00:00</CreationDate>
      <Id>7d596ae4-8b03-471d-8dd2-2ba7e793ab85</Id>
      <ModuleSettingId>f4ffc90d-300c-4c41-9648-97f37de4c777</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>a7739abb-e7fc-4563-a9f4-f4fa043d7ad8</TenantId>
  <Url>sample string 3</Url>
  <UserJourneyId>88180bd8-9c91-40ea-8121-7fbc44adc8e8</UserJourneyId>
</ModuleSettingDto>