GET Api/v{apiVersion}/Campaigns?storeid={storeid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of campaigns

Request Information

URI Parameters

Name	Description	Type	Additional information
storeid	Optional: only return items for a specific Store	globally unique identifier	None.
query	Optional: search query (e.g. Name.Equals("John Doe") or Name.Contains("Doe"))	string	Default value is
pageSize	Optional: page size, used for server-side paging (e.g. 10)	integer	None.
currentPage	Optional: current page, used for server-side paging (e.g. 1)	integer	None.
orderBy	Optional: property used to order the data, used for server-side ordering (e.g. Name)	string	Default value is
descending	Optional: ordering type (e.g. True)	boolean	None.
apiVersion		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CampaignPreview

Name	Type	Additional information
CampaignID	globally unique identifier	None.
Customer	CustomerPreview	None.
Name	string	None.
Type	CampaignType	None.
Status	CampaignStatus	None.
StartDate	date	None.
EndDate	date	None.
IsRunning	boolean	None.
IsOrderingAllowed	boolean	None.
NumberOfOrders	integer	None.
TotalBudgetAmount	decimal number	None.
TotalSpentAmount	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CampaignID": "566d27cf-7243-465b-8f9f-c33722a057cf",
    "Customer": {
      "CustomerID": "795f55b5-79dc-4f76-97b2-2c5f343176ac",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "Address": "sample string 4",
      "City": {
        "AreaID": "52633ecd-527f-4c4b-ac0d-b14e577c61ba",
        "ParentID": "6615cd9f-8ddc-4980-87af-18cd1d3f6b3f",
        "ParentName": "sample string 2",
        "SupplierName": "sample string 3",
        "CustomerName": "sample string 4",
        "StoreName": "sample string 5",
        "Code": "sample string 6",
        "Name": "sample string 7",
        "Type": "Neighbourhood",
        "Status": "InActive",
        "OwnerName": "sample string 8",
        "Population": 9,
        "Mailboxes": 10
      },
      "Postcode": "sample string 5",
      "IsBackendCustomer": true,
      "Contact": "sample string 7",
      "PhoneNumber": "sample string 8"
    },
    "Name": "sample string 2",
    "Type": "NoInformation",
    "Status": "InActive",
    "StartDate": "2026-01-15T14:18:24.801555Z",
    "EndDate": "2026-01-15T14:18:24.801555Z",
    "IsRunning": true,
    "IsOrderingAllowed": true,
    "NumberOfOrders": 7,
    "TotalBudgetAmount": 1.1,
    "TotalSpentAmount": 8.1
  },
  {
    "CampaignID": "566d27cf-7243-465b-8f9f-c33722a057cf",
    "Customer": {
      "CustomerID": "795f55b5-79dc-4f76-97b2-2c5f343176ac",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "Address": "sample string 4",
      "City": {
        "AreaID": "52633ecd-527f-4c4b-ac0d-b14e577c61ba",
        "ParentID": "6615cd9f-8ddc-4980-87af-18cd1d3f6b3f",
        "ParentName": "sample string 2",
        "SupplierName": "sample string 3",
        "CustomerName": "sample string 4",
        "StoreName": "sample string 5",
        "Code": "sample string 6",
        "Name": "sample string 7",
        "Type": "Neighbourhood",
        "Status": "InActive",
        "OwnerName": "sample string 8",
        "Population": 9,
        "Mailboxes": 10
      },
      "Postcode": "sample string 5",
      "IsBackendCustomer": true,
      "Contact": "sample string 7",
      "PhoneNumber": "sample string 8"
    },
    "Name": "sample string 2",
    "Type": "NoInformation",
    "Status": "InActive",
    "StartDate": "2026-01-15T14:18:24.801555Z",
    "EndDate": "2026-01-15T14:18:24.801555Z",
    "IsRunning": true,
    "IsOrderingAllowed": true,
    "NumberOfOrders": 7,
    "TotalBudgetAmount": 1.1,
    "TotalSpentAmount": 8.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfCampaignPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <CampaignPreview>
    <CampaignID>566d27cf-7243-465b-8f9f-c33722a057cf</CampaignID>
    <Customer>
      <Address>sample string 4</Address>
      <City>
        <AreaID>52633ecd-527f-4c4b-ac0d-b14e577c61ba</AreaID>
        <Code>sample string 6</Code>
        <CustomerName>sample string 4</CustomerName>
        <Mailboxes>10</Mailboxes>
        <Name>sample string 7</Name>
        <OwnerName>sample string 8</OwnerName>
        <ParentID>6615cd9f-8ddc-4980-87af-18cd1d3f6b3f</ParentID>
        <ParentName>sample string 2</ParentName>
        <Population>9</Population>
        <Status>InActive</Status>
        <StoreName>sample string 5</StoreName>
        <SupplierName>sample string 3</SupplierName>
        <Type>Neighbourhood</Type>
      </City>
      <Contact>sample string 7</Contact>
      <CustomerID>795f55b5-79dc-4f76-97b2-2c5f343176ac</CustomerID>
      <IsBackendCustomer>true</IsBackendCustomer>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Postcode>sample string 5</Postcode>
      <Status>InActive</Status>
    </Customer>
    <EndDate>2026-01-15T15:18:24.801555+01:00</EndDate>
    <IsOrderingAllowed>true</IsOrderingAllowed>
    <IsRunning>true</IsRunning>
    <Name>sample string 2</Name>
    <NumberOfOrders>7</NumberOfOrders>
    <StartDate>2026-01-15T15:18:24.801555+01:00</StartDate>
    <Status>InActive</Status>
    <TotalBudgetAmount>1.1</TotalBudgetAmount>
    <TotalSpentAmount>8.1</TotalSpentAmount>
    <Type>NoInformation</Type>
  </CampaignPreview>
  <CampaignPreview>
    <CampaignID>566d27cf-7243-465b-8f9f-c33722a057cf</CampaignID>
    <Customer>
      <Address>sample string 4</Address>
      <City>
        <AreaID>52633ecd-527f-4c4b-ac0d-b14e577c61ba</AreaID>
        <Code>sample string 6</Code>
        <CustomerName>sample string 4</CustomerName>
        <Mailboxes>10</Mailboxes>
        <Name>sample string 7</Name>
        <OwnerName>sample string 8</OwnerName>
        <ParentID>6615cd9f-8ddc-4980-87af-18cd1d3f6b3f</ParentID>
        <ParentName>sample string 2</ParentName>
        <Population>9</Population>
        <Status>InActive</Status>
        <StoreName>sample string 5</StoreName>
        <SupplierName>sample string 3</SupplierName>
        <Type>Neighbourhood</Type>
      </City>
      <Contact>sample string 7</Contact>
      <CustomerID>795f55b5-79dc-4f76-97b2-2c5f343176ac</CustomerID>
      <IsBackendCustomer>true</IsBackendCustomer>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Postcode>sample string 5</Postcode>
      <Status>InActive</Status>
    </Customer>
    <EndDate>2026-01-15T15:18:24.801555+01:00</EndDate>
    <IsOrderingAllowed>true</IsOrderingAllowed>
    <IsRunning>true</IsRunning>
    <Name>sample string 2</Name>
    <NumberOfOrders>7</NumberOfOrders>
    <StartDate>2026-01-15T15:18:24.801555+01:00</StartDate>
    <Status>InActive</Status>
    <TotalBudgetAmount>1.1</TotalBudgetAmount>
    <TotalSpentAmount>8.1</TotalSpentAmount>
    <Type>NoInformation</Type>
  </CampaignPreview>
</ArrayOfCampaignPreview>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].CampaignID"

566d27cf-7243-465b-8f9f-c33722a057cf
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.CustomerID"

795f55b5-79dc-4f76-97b2-2c5f343176ac
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.AreaID"

52633ecd-527f-4c4b-ac0d-b14e577c61ba
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.ParentID"

6615cd9f-8ddc-4980-87af-18cd1d3f6b3f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.Contact"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Customer.PhoneNumber"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Type"

NoInformation
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].StartDate"

2026-01-15T15:18:24.8015550+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].EndDate"

2026-01-15T15:18:24.8015550+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsRunning"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsOrderingAllowed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].NumberOfOrders"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].TotalBudgetAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].TotalSpentAmount"

8.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].CampaignID"

566d27cf-7243-465b-8f9f-c33722a057cf
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.CustomerID"

795f55b5-79dc-4f76-97b2-2c5f343176ac
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.AreaID"

52633ecd-527f-4c4b-ac0d-b14e577c61ba
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.ParentID"

6615cd9f-8ddc-4980-87af-18cd1d3f6b3f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.Contact"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Customer.PhoneNumber"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Type"

NoInformation
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].StartDate"

2026-01-15T15:18:24.8015550+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].EndDate"

2026-01-15T15:18:24.8015550+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsRunning"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsOrderingAllowed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].NumberOfOrders"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].TotalBudgetAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].TotalSpentAmount"

8.1
--MultipartDataMediaFormatterBoundary1q2w3e--