GET api/MarketingLists?APIKey={APIKey}&ClientId={ClientId}&MarketingListId={MarketingListId}&IncludeMembers={IncludeMembers}&PageNumber={PageNumber}&PageCount={PageCount}&PagingCookie={PagingCookie}

Request Information

URI Parameters

Name	Type	Additional information
APIKey	string	Required
ClientId	string	Required
MarketingListId	globally unique identifier	None.
IncludeMembers	boolean	Default value is False
PageNumber	integer	Default value is 1
PageCount	integer	Default value is 250
PagingCookie	string	Default value is

Body Parameters

None.

Response Information

Resource Description

MarketingLists

Name	Type	Additional information
Status	Status	None.
Description	string	None.
MoreRecords	boolean	None.
PagingCookie	string	None.
RecordsCount	integer	None.
MarketingList	Collection of MarketingList	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "Description": "sample string 1",
  "MoreRecords": true,
  "PagingCookie": "sample string 3",
  "RecordsCount": 4,
  "MarketingList": [
    {
      "Id": "8185c18b-0540-4a4c-862c-3da2816551de",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "DynamicQuery": "sample string 4",
      "MembersCount": 5,
      "Members": [
        {
          "Attributes": [
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            },
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            }
          ]
        },
        {
          "Attributes": [
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            },
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            }
          ]
        }
      ]
    },
    {
      "Id": "8185c18b-0540-4a4c-862c-3da2816551de",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "DynamicQuery": "sample string 4",
      "MembersCount": 5,
      "Members": [
        {
          "Attributes": [
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            },
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            }
          ]
        },
        {
          "Attributes": [
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            },
            {
              "Key": "sample string 1",
              "Value": "sample string 2",
              "FormattedValue": "sample string 3",
              "AttributeType": "sample string 4"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<MarketingLists xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Core">
  <Description>sample string 1</Description>
  <MarketingList>
    <MarketingList>
      <DynamicQuery>sample string 4</DynamicQuery>
      <Id>8185c18b-0540-4a4c-862c-3da2816551de</Id>
      <Members>
        <Record>
          <Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
          </Attributes>
        </Record>
        <Record>
          <Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
          </Attributes>
        </Record>
      </Members>
      <MembersCount>5</MembersCount>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </MarketingList>
    <MarketingList>
      <DynamicQuery>sample string 4</DynamicQuery>
      <Id>8185c18b-0540-4a4c-862c-3da2816551de</Id>
      <Members>
        <Record>
          <Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
          </Attributes>
        </Record>
        <Record>
          <Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
            <Attributes>
              <AttributeType>sample string 4</AttributeType>
              <FormattedValue>sample string 3</FormattedValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </Attributes>
          </Attributes>
        </Record>
      </Members>
      <MembersCount>5</MembersCount>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </MarketingList>
  </MarketingList>
  <MoreRecords>true</MoreRecords>
  <PagingCookie>sample string 3</PagingCookie>
  <RecordsCount>4</RecordsCount>
  <Status>Success</Status>
</MarketingLists>