GET Api/v{apiVersion}/Campaigns/{id}

Gets the campaign details

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required
apiVersion		string	None.

Body Parameters

None.

Response Information

Resource Description

CampaignDetails

Name	Type	Additional information
CampaignID	globally unique identifier	None.
Customer	CustomerPreview	None.
Name	string	None.
Type	CampaignType	None.
Status	CampaignStatus	None.
Description	string	None.
StartDate	date	None.
EndDate	date	None.
IsRunning	boolean	None.
IsOrderingAllowed	boolean	None.
NumberOfOrders	integer	None.
TotalBudgetAmount	decimal number	None.
TotalSpentAmount	decimal number	None.
InvoiceReceiver	InvoiceReceiver	None.
IsApprovalRequired	boolean	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CampaignID": "0ac6bcf6-fdb9-4849-9e9a-1792331a3639",
  "Customer": {
    "CustomerID": "54667281-541f-4dd5-8ce1-0fa15c477cbd",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Status": "InActive",
    "Address": "sample string 4",
    "City": {
      "AreaID": "05d5421a-55d6-4b61-8ee0-33079c41b9cb",
      "ParentID": "7f0d90a0-d945-4e14-893c-24526b11748e",
      "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",
  "Description": "sample string 3",
  "StartDate": "2026-01-15T13:46:51.2402016Z",
  "EndDate": "2026-01-15T13:46:51.2402016Z",
  "IsRunning": true,
  "IsOrderingAllowed": true,
  "NumberOfOrders": 8,
  "TotalBudgetAmount": 1.1,
  "TotalSpentAmount": 9.1,
  "InvoiceReceiver": "Customer",
  "IsApprovalRequired": true,
  "Notes": "sample string 11",
  "CreatedAt": "2026-01-15T13:46:51.2402016Z",
  "CreatedBy": "sample string 13",
  "ModifiedAt": "2026-01-15T13:46:51.2402016Z",
  "ModifiedBy": "sample string 15"
}

application/xml, text/xml

Sample:

<CampaignDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <CampaignID>0ac6bcf6-fdb9-4849-9e9a-1792331a3639</CampaignID>
  <CreatedAt>2026-01-15T14:46:51.2402016+01:00</CreatedAt>
  <CreatedBy>sample string 13</CreatedBy>
  <Customer>
    <Address>sample string 4</Address>
    <City>
      <AreaID>05d5421a-55d6-4b61-8ee0-33079c41b9cb</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>7f0d90a0-d945-4e14-893c-24526b11748e</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>54667281-541f-4dd5-8ce1-0fa15c477cbd</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>
  <Description>sample string 3</Description>
  <EndDate>2026-01-15T14:46:51.2402016+01:00</EndDate>
  <InvoiceReceiver>Customer</InvoiceReceiver>
  <IsApprovalRequired>true</IsApprovalRequired>
  <IsOrderingAllowed>true</IsOrderingAllowed>
  <IsRunning>true</IsRunning>
  <ModifiedAt>2026-01-15T14:46:51.2402016+01:00</ModifiedAt>
  <ModifiedBy>sample string 15</ModifiedBy>
  <Name>sample string 2</Name>
  <Notes>sample string 11</Notes>
  <NumberOfOrders>8</NumberOfOrders>
  <StartDate>2026-01-15T14:46:51.2402016+01:00</StartDate>
  <Status>InActive</Status>
  <TotalBudgetAmount>1.1</TotalBudgetAmount>
  <TotalSpentAmount>9.1</TotalSpentAmount>
  <Type>NoInformation</Type>
</CampaignDetails>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CampaignID"

0ac6bcf6-fdb9-4849-9e9a-1792331a3639
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.CustomerID"

54667281-541f-4dd5-8ce1-0fa15c477cbd
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.ParentName"

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

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

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

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

05d5421a-55d6-4b61-8ee0-33079c41b9cb
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.City.ParentID"

7f0d90a0-d945-4e14-893c-24526b11748e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.City.ParentName"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Type"

NoInformation
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Description"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StartDate"

2026-01-15T14:46:51.2402016+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EndDate"

2026-01-15T14:46:51.2402016+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsRunning"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOrderingAllowed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NumberOfOrders"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TotalBudgetAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TotalSpentAmount"

9.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="InvoiceReceiver"

Customer
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsApprovalRequired"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-01-15T14:46:51.2402016+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-01-15T14:46:51.2402016+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e--