GET api/account/customer

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
ID	integer	None.
UniqueID	globally unique identifier	None.
CreatedDate	date	None.
EditedDate	date	None.
TitleID	integer	None.
Title	PersonTitle	None.
FirstName	string	None.
LastName	string	None.
Name	string	None.
DisplayFullName	string	None.
Email	string	Required
Phone	string	None.
Mobile	string	None.
Password	string	None.
DOB	date	None.
MarketingUnsubscribe	boolean	None.
SourceID	integer	None.
Source	MarketingSource	None.
SourceDetail	string	None.
ProductConsumeFreqID	integer	None.
ProductConsumeFreq	ProductConsumeFrequency	None.
Active	boolean	None.
IsConfirmed	boolean	None.
Notes	string	Max length: 1024
AdminNotes	string	Max length: 2048
CancelReason	string	Max length: 512
ProspectID	integer	None.
Prospect	CustomerProspect	None.
Addresses	Collection of CustomerAddress	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "UniqueID": "89ca2a28-71b0-4813-96bf-ddc8a8507a4f",
  "CreatedDate": "2025-12-13T21:23:54.4516008+00:00",
  "EditedDate": "2025-12-13T21:23:54.4516008+00:00",
  "TitleID": 1,
  "Title": {
    "ID": 1,
    "Name": "sample string 2"
  },
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Name": "sample string 4 sample string 5",
  "DisplayFullName": "sample string 2 sample string 4 sample string 5",
  "Email": "sample string 6",
  "Phone": "sample string 7",
  "Mobile": "sample string 8",
  "Password": "sample string 9",
  "DOB": "2025-12-13T21:23:54.4516008+00:00",
  "MarketingUnsubscribe": true,
  "SourceID": 1,
  "Source": {
    "ID": 1,
    "Name": "sample string 2",
    "CanExpandResponse": true,
    "ExpandDesc": "sample string 4"
  },
  "SourceDetail": "sample string 11",
  "ProductConsumeFreqID": 1,
  "ProductConsumeFreq": {
    "ID": 1,
    "Name": "sample string 2",
    "SortOrder": 3,
    "Active": true
  },
  "Active": true,
  "IsConfirmed": true,
  "Notes": "sample string 14",
  "AdminNotes": "sample string 15",
  "CancelReason": "sample string 16",
  "ProspectID": 1,
  "Prospect": {
    "ID": 1,
    "Email": "sample string 2",
    "CreatedDate": "2025-12-13T21:23:54.4516008+00:00"
  },
  "Addresses": [
    {
      "ID": 1,
      "CustomerID": 2,
      "TitleID": 1,
      "Title": {
        "ID": 1,
        "Name": "sample string 2"
      },
      "Active": true,
      "Nickname": "sample string 4",
      "FirstName": "sample string 5",
      "LastName": "sample string 6",
      "Name": "sample string 5 sample string 6",
      "Organisation": "sample string 7",
      "AddressLine1": "sample string 8",
      "AddressLine2": "sample string 9",
      "City": "sample string 10",
      "Region": "sample string 11",
      "Postcode": "sample string 12",
      "CountryID": 13,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "Code": "sample string 3"
      },
      "Phone": "sample string 14",
      "Email": "sample string 15",
      "DeliveryInstructions": "sample string 16",
      "IsDefault": true,
      "IsBilling": true,
      "DeliveryOffset": 19,
      "DeliveryAreaID": 1,
      "DeliveryArea": {
        "ID": 1,
        "Name": "sample string 2",
        "Codename": "sample string 3",
        "SortOrder": 4,
        "Active": true,
        "IsDefault": true,
        "BoxOrderMargin": 1.0,
        "BoxOrderTolerance": 1.0,
        "FishboxMargin": 1.0,
        "DefaultCourierID": 1,
        "DefaultCourier": {
          "ID": 1,
          "TypeID": 2,
          "CourierType": {
            "ID": 1,
            "Name": "sample string 2"
          },
          "Key": 2,
          "Name": "sample string 3",
          "Active": true,
          "IsDefault": true
        }
      },
      "CourierID": 1,
      "Courier": {
        "ID": 1,
        "TypeID": 2,
        "CourierType": {
          "ID": 1,
          "Name": "sample string 2"
        },
        "Key": 2,
        "Name": "sample string 3",
        "Active": true,
        "IsDefault": true
      },
      "DisplayAddress": "sample string 8\nsample string 9\nsample string 10\nsample string 11\nsample string 12\nsample string 2",
      "DisplayName": "sample string 5 sample string 6sample string 8"
    },
    {
      "ID": 1,
      "CustomerID": 2,
      "TitleID": 1,
      "Title": {
        "ID": 1,
        "Name": "sample string 2"
      },
      "Active": true,
      "Nickname": "sample string 4",
      "FirstName": "sample string 5",
      "LastName": "sample string 6",
      "Name": "sample string 5 sample string 6",
      "Organisation": "sample string 7",
      "AddressLine1": "sample string 8",
      "AddressLine2": "sample string 9",
      "City": "sample string 10",
      "Region": "sample string 11",
      "Postcode": "sample string 12",
      "CountryID": 13,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "Code": "sample string 3"
      },
      "Phone": "sample string 14",
      "Email": "sample string 15",
      "DeliveryInstructions": "sample string 16",
      "IsDefault": true,
      "IsBilling": true,
      "DeliveryOffset": 19,
      "DeliveryAreaID": 1,
      "DeliveryArea": {
        "ID": 1,
        "Name": "sample string 2",
        "Codename": "sample string 3",
        "SortOrder": 4,
        "Active": true,
        "IsDefault": true,
        "BoxOrderMargin": 1.0,
        "BoxOrderTolerance": 1.0,
        "FishboxMargin": 1.0,
        "DefaultCourierID": 1,
        "DefaultCourier": {
          "ID": 1,
          "TypeID": 2,
          "CourierType": {
            "ID": 1,
            "Name": "sample string 2"
          },
          "Key": 2,
          "Name": "sample string 3",
          "Active": true,
          "IsDefault": true
        }
      },
      "CourierID": 1,
      "Courier": {
        "ID": 1,
        "TypeID": 2,
        "CourierType": {
          "ID": 1,
          "Name": "sample string 2"
        },
        "Key": 2,
        "Name": "sample string 3",
        "Active": true,
        "IsDefault": true
      },
      "DisplayAddress": "sample string 8\nsample string 9\nsample string 10\nsample string 11\nsample string 12\nsample string 2",
      "DisplayName": "sample string 5 sample string 6sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Customers">
  <Active>true</Active>
  <Addresses>
    <CustomerAddress>
      <Active>true</Active>
      <AddressLine1>sample string 8</AddressLine1>
      <AddressLine2>sample string 9</AddressLine2>
      <City>sample string 10</City>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
        <d4p1:Code>sample string 3</d4p1:Code>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <CountryID>13</CountryID>
      <Courier xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:CourierType>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CourierType>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsDefault>true</d4p1:IsDefault>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:TypeID>2</d4p1:TypeID>
      </Courier>
      <CourierID>1</CourierID>
      <CustomerID>2</CustomerID>
      <DeliveryArea xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Delivery">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:BoxOrderMargin>1</d4p1:BoxOrderMargin>
        <d4p1:BoxOrderTolerance>1</d4p1:BoxOrderTolerance>
        <d4p1:Codename>sample string 3</d4p1:Codename>
        <d4p1:DefaultCourier xmlns:d5p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
          <d5p1:Active>true</d5p1:Active>
          <d5p1:CourierType>
            <d5p1:ID>1</d5p1:ID>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:CourierType>
          <d5p1:ID>1</d5p1:ID>
          <d5p1:IsDefault>true</d5p1:IsDefault>
          <d5p1:Name>sample string 3</d5p1:Name>
          <d5p1:TypeID>2</d5p1:TypeID>
        </d4p1:DefaultCourier>
        <d4p1:DefaultCourierID>1</d4p1:DefaultCourierID>
        <d4p1:FishboxMargin>1</d4p1:FishboxMargin>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsDefault>true</d4p1:IsDefault>
        <d4p1:Name>sample string 2</d4p1:Name>
        <d4p1:SortOrder>4</d4p1:SortOrder>
      </DeliveryArea>
      <DeliveryAreaID>1</DeliveryAreaID>
      <DeliveryInstructions>sample string 16</DeliveryInstructions>
      <DeliveryOffset>19</DeliveryOffset>
      <Email>sample string 15</Email>
      <FirstName>sample string 5</FirstName>
      <ID>1</ID>
      <IsBilling>true</IsBilling>
      <IsDefault>true</IsDefault>
      <LastName>sample string 6</LastName>
      <Nickname>sample string 4</Nickname>
      <Organisation>sample string 7</Organisation>
      <Phone>sample string 14</Phone>
      <Postcode>sample string 12</Postcode>
      <Region>sample string 11</Region>
      <Title xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Title>
      <TitleID>1</TitleID>
    </CustomerAddress>
    <CustomerAddress>
      <Active>true</Active>
      <AddressLine1>sample string 8</AddressLine1>
      <AddressLine2>sample string 9</AddressLine2>
      <City>sample string 10</City>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
        <d4p1:Code>sample string 3</d4p1:Code>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <CountryID>13</CountryID>
      <Courier xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:CourierType>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CourierType>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsDefault>true</d4p1:IsDefault>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:TypeID>2</d4p1:TypeID>
      </Courier>
      <CourierID>1</CourierID>
      <CustomerID>2</CustomerID>
      <DeliveryArea xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Delivery">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:BoxOrderMargin>1</d4p1:BoxOrderMargin>
        <d4p1:BoxOrderTolerance>1</d4p1:BoxOrderTolerance>
        <d4p1:Codename>sample string 3</d4p1:Codename>
        <d4p1:DefaultCourier xmlns:d5p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
          <d5p1:Active>true</d5p1:Active>
          <d5p1:CourierType>
            <d5p1:ID>1</d5p1:ID>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:CourierType>
          <d5p1:ID>1</d5p1:ID>
          <d5p1:IsDefault>true</d5p1:IsDefault>
          <d5p1:Name>sample string 3</d5p1:Name>
          <d5p1:TypeID>2</d5p1:TypeID>
        </d4p1:DefaultCourier>
        <d4p1:DefaultCourierID>1</d4p1:DefaultCourierID>
        <d4p1:FishboxMargin>1</d4p1:FishboxMargin>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsDefault>true</d4p1:IsDefault>
        <d4p1:Name>sample string 2</d4p1:Name>
        <d4p1:SortOrder>4</d4p1:SortOrder>
      </DeliveryArea>
      <DeliveryAreaID>1</DeliveryAreaID>
      <DeliveryInstructions>sample string 16</DeliveryInstructions>
      <DeliveryOffset>19</DeliveryOffset>
      <Email>sample string 15</Email>
      <FirstName>sample string 5</FirstName>
      <ID>1</ID>
      <IsBilling>true</IsBilling>
      <IsDefault>true</IsDefault>
      <LastName>sample string 6</LastName>
      <Nickname>sample string 4</Nickname>
      <Organisation>sample string 7</Organisation>
      <Phone>sample string 14</Phone>
      <Postcode>sample string 12</Postcode>
      <Region>sample string 11</Region>
      <Title xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Title>
      <TitleID>1</TitleID>
    </CustomerAddress>
  </Addresses>
  <AdminNotes>sample string 15</AdminNotes>
  <CancelReason>sample string 16</CancelReason>
  <CreatedDate>2025-12-13T21:23:54.4516008+00:00</CreatedDate>
  <DOB>2025-12-13T21:23:54.4516008+00:00</DOB>
  <EditedDate>2025-12-13T21:23:54.4516008+00:00</EditedDate>
  <Email>sample string 6</Email>
  <FirstName>sample string 4</FirstName>
  <ID>1</ID>
  <IsConfirmed>true</IsConfirmed>
  <LastName>sample string 5</LastName>
  <MarketingUnsubscribe>true</MarketingUnsubscribe>
  <Mobile>sample string 8</Mobile>
  <Notes>sample string 14</Notes>
  <Password>sample string 9</Password>
  <Phone>sample string 7</Phone>
  <ProductConsumeFreq>
    <Active>true</Active>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <SortOrder>3</SortOrder>
  </ProductConsumeFreq>
  <ProductConsumeFreqID>1</ProductConsumeFreqID>
  <Prospect>
    <CreatedDate>2025-12-13T21:23:54.4516008+00:00</CreatedDate>
    <Email>sample string 2</Email>
    <ID>1</ID>
  </Prospect>
  <ProspectID>1</ProspectID>
  <Source xmlns:d2p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
    <d2p1:CanExpandResponse>true</d2p1:CanExpandResponse>
    <d2p1:ExpandDesc>sample string 4</d2p1:ExpandDesc>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Source>
  <SourceDetail>sample string 11</SourceDetail>
  <SourceID>1</SourceID>
  <Title xmlns:d2p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Title>
  <TitleID>1</TitleID>
  <UniqueID>89ca2a28-71b0-4813-96bf-ddc8a8507a4f</UniqueID>
</Customer>