GET api/Customers

Gets all customers using paging.

Request Information

URI Parameters

None.

Body Parameters

None.

Remarks

None.

Example

//Gets all customers in first page.
http://localhost/api/customers

//Gets all customers in the fifth page.
http://localhost/api/customers?pageNumber=5&pageSize=25

//Gets all customers in the fifth page with default page size of 25.
http://localhost/api/customers?pageNumber=5

Response Information

Resource Description

All customers in the current page.

PagedCustomerResponse
NameDescriptionTypeAdditional information
CustomerReponse

List of customers in the requested page.

 Collection of CustomerResponse

None.
TotalPages

Total number of pages.

 integer

None.
NextPage

Link to the next page.

 string

None.
PreviousPage

Link to the previous page.

 string

None.
LastPage

Link to the last page.

 string

None.
FirstPage

Link to the first page.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CustomerReponse": [
    {
      "Id": "73f3819f-5bae-407e-9d12-7f03e5efe595",
      "BranchName": "sample string 2",
      "CountryName": "sample string 3",
      "CustomerCategoryId1Name": "sample string 4",
      "CustomerCategoryId2Name": "sample string 5",
      "Agreements": [
        {
          "ZoneId": 1,
          "Number": 1,
          "FixedProductRange": true
        },
        {
          "ZoneId": 1,
          "Number": 1,
          "FixedProductRange": true
        }
      ],
      "CreatedBy": "sample string 6",
      "Created": "12/21/2025 1:04:50 PM",
      "ChangedBy": "sample string 7",
      "Changed": "12/21/2025 1:04:50 PM",
      "DeliveryAddresses": [
        {
          "Id": "b415e7bd-fdce-4262-b4bd-699890551552",
          "CountryName": "sample string 2",
          "Name": "sample string 3",
          "Address1": "sample string 4",
          "Address2": "sample string 5",
          "Address3": "sample string 6",
          "PostalCode": "sample string 7",
          "Town": "sample string 8",
          "CountryId": "sample string 9",
          "Phone1": "sample string 10",
          "Phone2": "sample string 11",
          "IsDefaultAddress": true
        },
        {
          "Id": "b415e7bd-fdce-4262-b4bd-699890551552",
          "CountryName": "sample string 2",
          "Name": "sample string 3",
          "Address1": "sample string 4",
          "Address2": "sample string 5",
          "Address3": "sample string 6",
          "PostalCode": "sample string 7",
          "Town": "sample string 8",
          "CountryId": "sample string 9",
          "Phone1": "sample string 10",
          "Phone2": "sample string 11",
          "IsDefaultAddress": true
        }
      ],
      "BreakdownServiceTypeName": "sample string 8",
      "CurrentClaim": 1.0,
      "CreditLimit": 1.0,
      "FreezeFlag": true,
      "CSID": 1,
      "CustomerNo": 10,
      "BranchId": 1,
      "SearchCode": "sample string 11",
      "Name": "sample string 12",
      "OrgNo": "sample string 13",
      "Address1": "sample string 14",
      "Address2": "sample string 15",
      "Address3": "sample string 16",
      "PostalCode": "sample string 17",
      "Town": "sample string 18",
      "CountryId": "sample string 19",
      "BoardHome": "sample string 20",
      "Phone1": "sample string 21",
      "Phone2": "sample string 22",
      "WebSite": "sample string 23",
      "Email": "sample string 24",
      "Note": "sample string 25",
      "PreferredCultureId": "sample string 26",
      "VatRegistrationNumber": "sample string 27",
      "CustomerCategoryId1": 1,
      "CustomerCategoryId2": 1,
      "ReferencePerson": "sample string 28",
      "ContactPerson": "sample string 29",
      "DistrictId": 1,
      "PaysVAT": true,
      "BreakdownServiceTypeId": 1,
      "YourReference": "sample string 31",
      "RequisitionOrderNumber": "sample string 32",
      "InternalWorkingOrderNumber": "sample string 33",
      "ParentCustomerNo": 1,
      "SalesPerson": "sample string 34",
      "Export": true,
      "WithinEU": true,
      "Inactive": true,
      "TransportationScheduleId": 1,
      "IsCompany": true,
      "GDPRConsentDate": "12/21/2025 1:04:50 PM",
      "CustomerType": "sample string 38",
      "DocumentPath": "sample string 39",
      "ExternalReference": "sample string 40",
      "GlobalLocationNumber": "sample string 41",
      "InterestInvoice": true,
      "IsCashCustomer": true,
      "RegionId": 1
    },
    {
      "Id": "73f3819f-5bae-407e-9d12-7f03e5efe595",
      "BranchName": "sample string 2",
      "CountryName": "sample string 3",
      "CustomerCategoryId1Name": "sample string 4",
      "CustomerCategoryId2Name": "sample string 5",
      "Agreements": [
        {
          "ZoneId": 1,
          "Number": 1,
          "FixedProductRange": true
        },
        {
          "ZoneId": 1,
          "Number": 1,
          "FixedProductRange": true
        }
      ],
      "CreatedBy": "sample string 6",
      "Created": "12/21/2025 1:04:50 PM",
      "ChangedBy": "sample string 7",
      "Changed": "12/21/2025 1:04:50 PM",
      "DeliveryAddresses": [
        {
          "Id": "b415e7bd-fdce-4262-b4bd-699890551552",
          "CountryName": "sample string 2",
          "Name": "sample string 3",
          "Address1": "sample string 4",
          "Address2": "sample string 5",
          "Address3": "sample string 6",
          "PostalCode": "sample string 7",
          "Town": "sample string 8",
          "CountryId": "sample string 9",
          "Phone1": "sample string 10",
          "Phone2": "sample string 11",
          "IsDefaultAddress": true
        },
        {
          "Id": "b415e7bd-fdce-4262-b4bd-699890551552",
          "CountryName": "sample string 2",
          "Name": "sample string 3",
          "Address1": "sample string 4",
          "Address2": "sample string 5",
          "Address3": "sample string 6",
          "PostalCode": "sample string 7",
          "Town": "sample string 8",
          "CountryId": "sample string 9",
          "Phone1": "sample string 10",
          "Phone2": "sample string 11",
          "IsDefaultAddress": true
        }
      ],
      "BreakdownServiceTypeName": "sample string 8",
      "CurrentClaim": 1.0,
      "CreditLimit": 1.0,
      "FreezeFlag": true,
      "CSID": 1,
      "CustomerNo": 10,
      "BranchId": 1,
      "SearchCode": "sample string 11",
      "Name": "sample string 12",
      "OrgNo": "sample string 13",
      "Address1": "sample string 14",
      "Address2": "sample string 15",
      "Address3": "sample string 16",
      "PostalCode": "sample string 17",
      "Town": "sample string 18",
      "CountryId": "sample string 19",
      "BoardHome": "sample string 20",
      "Phone1": "sample string 21",
      "Phone2": "sample string 22",
      "WebSite": "sample string 23",
      "Email": "sample string 24",
      "Note": "sample string 25",
      "PreferredCultureId": "sample string 26",
      "VatRegistrationNumber": "sample string 27",
      "CustomerCategoryId1": 1,
      "CustomerCategoryId2": 1,
      "ReferencePerson": "sample string 28",
      "ContactPerson": "sample string 29",
      "DistrictId": 1,
      "PaysVAT": true,
      "BreakdownServiceTypeId": 1,
      "YourReference": "sample string 31",
      "RequisitionOrderNumber": "sample string 32",
      "InternalWorkingOrderNumber": "sample string 33",
      "ParentCustomerNo": 1,
      "SalesPerson": "sample string 34",
      "Export": true,
      "WithinEU": true,
      "Inactive": true,
      "TransportationScheduleId": 1,
      "IsCompany": true,
      "GDPRConsentDate": "12/21/2025 1:04:50 PM",
      "CustomerType": "sample string 38",
      "DocumentPath": "sample string 39",
      "ExternalReference": "sample string 40",
      "GlobalLocationNumber": "sample string 41",
      "InterestInvoice": true,
      "IsCashCustomer": true,
      "RegionId": 1
    }
  ],
  "TotalPages": 1,
  "NextPage": "sample string 2",
  "PreviousPage": "sample string 3",
  "LastPage": "sample string 4",
  "FirstPage": "sample string 5"
}

application/xml, text/xml

Sample: 
<PagedCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business">
  <FirstPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 5</FirstPage>
  <LastPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 4</LastPage>
  <NextPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 2</NextPage>
  <PreviousPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 3</PreviousPage>
  <TotalPages xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">1</TotalPages>
  <CustomerReponse>
    <CustomerResponse>
      <Address1>sample string 14</Address1>
      <Address2>sample string 15</Address2>
      <Address3>sample string 16</Address3>
      <BoardHome>sample string 20</BoardHome>
      <BranchId>1</BranchId>
      <BreakdownServiceTypeId>1</BreakdownServiceTypeId>
      <ContactPerson>sample string 29</ContactPerson>
      <CountryId>sample string 19</CountryId>
      <CustomerCategoryId1>1</CustomerCategoryId1>
      <CustomerCategoryId2>1</CustomerCategoryId2>
      <CustomerNo>10</CustomerNo>
      <CustomerType>sample string 38</CustomerType>
      <DistrictId>1</DistrictId>
      <DocumentPath>sample string 39</DocumentPath>
      <Email>sample string 24</Email>
      <Export>true</Export>
      <ExternalReference>sample string 40</ExternalReference>
      <GDPRConsentDate>2025-12-21T13:04:50.2477553+00:00</GDPRConsentDate>
      <GlobalLocationNumber>sample string 41</GlobalLocationNumber>
      <Inactive>true</Inactive>
      <InterestInvoice>true</InterestInvoice>
      <InternalWorkingOrderNumber>sample string 33</InternalWorkingOrderNumber>
      <IsCashCustomer>true</IsCashCustomer>
      <IsCompany>true</IsCompany>
      <Name>sample string 12</Name>
      <Note>sample string 25</Note>
      <OrgNo>sample string 13</OrgNo>
      <ParentCustomerNo>1</ParentCustomerNo>
      <PaysVAT>true</PaysVAT>
      <Phone1>sample string 21</Phone1>
      <Phone2>sample string 22</Phone2>
      <PostalCode>sample string 17</PostalCode>
      <PreferredCultureId>sample string 26</PreferredCultureId>
      <ReferencePerson>sample string 28</ReferencePerson>
      <RegionId>1</RegionId>
      <RequisitionOrderNumber>sample string 32</RequisitionOrderNumber>
      <SalesPerson>sample string 34</SalesPerson>
      <SearchCode>sample string 11</SearchCode>
      <Town>sample string 18</Town>
      <TransportationScheduleId>1</TransportationScheduleId>
      <VatRegistrationNumber>sample string 27</VatRegistrationNumber>
      <WebSite>sample string 23</WebSite>
      <WithinEU>true</WithinEU>
      <YourReference>sample string 31</YourReference>
      <Agreements xmlns:d4p1="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
        <d4p1:AgreementResponseLite>
          <d4p1:FixedProductRange>true</d4p1:FixedProductRange>
          <d4p1:Number>1</d4p1:Number>
          <d4p1:ZoneId>1</d4p1:ZoneId>
        </d4p1:AgreementResponseLite>
        <d4p1:AgreementResponseLite>
          <d4p1:FixedProductRange>true</d4p1:FixedProductRange>
          <d4p1:Number>1</d4p1:Number>
          <d4p1:ZoneId>1</d4p1:ZoneId>
        </d4p1:AgreementResponseLite>
      </Agreements>
      <BranchName>sample string 2</BranchName>
      <BreakdownServiceTypeName>sample string 8</BreakdownServiceTypeName>
      <CSID>1</CSID>
      <Changed>2025-12-21T13:04:50.2477553+00:00</Changed>
      <ChangedBy>sample string 7</ChangedBy>
      <CountryName>sample string 3</CountryName>
      <Created>2025-12-21T13:04:50.2477553+00:00</Created>
      <CreatedBy>sample string 6</CreatedBy>
      <CreditLimit>1</CreditLimit>
      <CurrentClaim>1</CurrentClaim>
      <CustomerCategoryId1Name>sample string 4</CustomerCategoryId1Name>
      <CustomerCategoryId2Name>sample string 5</CustomerCategoryId2Name>
      <DeliveryAddresses>
        <DeliveryAddressResponse>
          <Address1>sample string 4</Address1>
          <Address2>sample string 5</Address2>
          <Address3>sample string 6</Address3>
          <CountryId>sample string 9</CountryId>
          <IsDefaultAddress>true</IsDefaultAddress>
          <Name>sample string 3</Name>
          <Phone1>sample string 10</Phone1>
          <Phone2>sample string 11</Phone2>
          <PostalCode>sample string 7</PostalCode>
          <Town>sample string 8</Town>
          <CountryName>sample string 2</CountryName>
          <Id>b415e7bd-fdce-4262-b4bd-699890551552</Id>
        </DeliveryAddressResponse>
        <DeliveryAddressResponse>
          <Address1>sample string 4</Address1>
          <Address2>sample string 5</Address2>
          <Address3>sample string 6</Address3>
          <CountryId>sample string 9</CountryId>
          <IsDefaultAddress>true</IsDefaultAddress>
          <Name>sample string 3</Name>
          <Phone1>sample string 10</Phone1>
          <Phone2>sample string 11</Phone2>
          <PostalCode>sample string 7</PostalCode>
          <Town>sample string 8</Town>
          <CountryName>sample string 2</CountryName>
          <Id>b415e7bd-fdce-4262-b4bd-699890551552</Id>
        </DeliveryAddressResponse>
      </DeliveryAddresses>
      <FreezeFlag>true</FreezeFlag>
      <Id>73f3819f-5bae-407e-9d12-7f03e5efe595</Id>
    </CustomerResponse>
    <CustomerResponse>
      <Address1>sample string 14</Address1>
      <Address2>sample string 15</Address2>
      <Address3>sample string 16</Address3>
      <BoardHome>sample string 20</BoardHome>
      <BranchId>1</BranchId>
      <BreakdownServiceTypeId>1</BreakdownServiceTypeId>
      <ContactPerson>sample string 29</ContactPerson>
      <CountryId>sample string 19</CountryId>
      <CustomerCategoryId1>1</CustomerCategoryId1>
      <CustomerCategoryId2>1</CustomerCategoryId2>
      <CustomerNo>10</CustomerNo>
      <CustomerType>sample string 38</CustomerType>
      <DistrictId>1</DistrictId>
      <DocumentPath>sample string 39</DocumentPath>
      <Email>sample string 24</Email>
      <Export>true</Export>
      <ExternalReference>sample string 40</ExternalReference>
      <GDPRConsentDate>2025-12-21T13:04:50.2477553+00:00</GDPRConsentDate>
      <GlobalLocationNumber>sample string 41</GlobalLocationNumber>
      <Inactive>true</Inactive>
      <InterestInvoice>true</InterestInvoice>
      <InternalWorkingOrderNumber>sample string 33</InternalWorkingOrderNumber>
      <IsCashCustomer>true</IsCashCustomer>
      <IsCompany>true</IsCompany>
      <Name>sample string 12</Name>
      <Note>sample string 25</Note>
      <OrgNo>sample string 13</OrgNo>
      <ParentCustomerNo>1</ParentCustomerNo>
      <PaysVAT>true</PaysVAT>
      <Phone1>sample string 21</Phone1>
      <Phone2>sample string 22</Phone2>
      <PostalCode>sample string 17</PostalCode>
      <PreferredCultureId>sample string 26</PreferredCultureId>
      <ReferencePerson>sample string 28</ReferencePerson>
      <RegionId>1</RegionId>
      <RequisitionOrderNumber>sample string 32</RequisitionOrderNumber>
      <SalesPerson>sample string 34</SalesPerson>
      <SearchCode>sample string 11</SearchCode>
      <Town>sample string 18</Town>
      <TransportationScheduleId>1</TransportationScheduleId>
      <VatRegistrationNumber>sample string 27</VatRegistrationNumber>
      <WebSite>sample string 23</WebSite>
      <WithinEU>true</WithinEU>
      <YourReference>sample string 31</YourReference>
      <Agreements xmlns:d4p1="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
        <d4p1:AgreementResponseLite>
          <d4p1:FixedProductRange>true</d4p1:FixedProductRange>
          <d4p1:Number>1</d4p1:Number>
          <d4p1:ZoneId>1</d4p1:ZoneId>
        </d4p1:AgreementResponseLite>
        <d4p1:AgreementResponseLite>
          <d4p1:FixedProductRange>true</d4p1:FixedProductRange>
          <d4p1:Number>1</d4p1:Number>
          <d4p1:ZoneId>1</d4p1:ZoneId>
        </d4p1:AgreementResponseLite>
      </Agreements>
      <BranchName>sample string 2</BranchName>
      <BreakdownServiceTypeName>sample string 8</BreakdownServiceTypeName>
      <CSID>1</CSID>
      <Changed>2025-12-21T13:04:50.2477553+00:00</Changed>
      <ChangedBy>sample string 7</ChangedBy>
      <CountryName>sample string 3</CountryName>
      <Created>2025-12-21T13:04:50.2477553+00:00</Created>
      <CreatedBy>sample string 6</CreatedBy>
      <CreditLimit>1</CreditLimit>
      <CurrentClaim>1</CurrentClaim>
      <CustomerCategoryId1Name>sample string 4</CustomerCategoryId1Name>
      <CustomerCategoryId2Name>sample string 5</CustomerCategoryId2Name>
      <DeliveryAddresses>
        <DeliveryAddressResponse>
          <Address1>sample string 4</Address1>
          <Address2>sample string 5</Address2>
          <Address3>sample string 6</Address3>
          <CountryId>sample string 9</CountryId>
          <IsDefaultAddress>true</IsDefaultAddress>
          <Name>sample string 3</Name>
          <Phone1>sample string 10</Phone1>
          <Phone2>sample string 11</Phone2>
          <PostalCode>sample string 7</PostalCode>
          <Town>sample string 8</Town>
          <CountryName>sample string 2</CountryName>
          <Id>b415e7bd-fdce-4262-b4bd-699890551552</Id>
        </DeliveryAddressResponse>
        <DeliveryAddressResponse>
          <Address1>sample string 4</Address1>
          <Address2>sample string 5</Address2>
          <Address3>sample string 6</Address3>
          <CountryId>sample string 9</CountryId>
          <IsDefaultAddress>true</IsDefaultAddress>
          <Name>sample string 3</Name>
          <Phone1>sample string 10</Phone1>
          <Phone2>sample string 11</Phone2>
          <PostalCode>sample string 7</PostalCode>
          <Town>sample string 8</Town>
          <CountryName>sample string 2</CountryName>
          <Id>b415e7bd-fdce-4262-b4bd-699890551552</Id>
        </DeliveryAddressResponse>
      </DeliveryAddresses>
      <FreezeFlag>true</FreezeFlag>
      <Id>73f3819f-5bae-407e-9d12-7f03e5efe595</Id>
    </CustomerResponse>
  </CustomerReponse>
</PagedCustomerResponse>