---
title: "getCustomersByPage"
method: GET
path: "/cruise/customer/v1/getCustomersByPage"
tags: ["Customer Service"]
---

# getCustomersByPage

`GET /cruise/customer/v1/getCustomersByPage`

## Request

- Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known)
- URL: `//webservices-test.net-chef.com/cruise/customer/v1/getCustomersByPage`
- Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid`

Retrieve customer account details by `pageNumber`. 
 Use to retrieve data in smaller chunks.

## Query parameters

- `activeFlag` boolean
- `customerAccountNumber` string
- `customerCode` string
- `locationCode` string
- `pageNumber` integer
- `pageSize` integer
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- CustomerBatchResponseDto: CustomerBatchResponseDto description
  - `customerDetails` CustomerDetailsRes[]
    - `customerDetailDetails` CustomerDetailsDtoRes[]
      - `activeFlag` string: "activeFlag" from Customer
      - `address1` string, required: "address1" from Customer
      - `address2` string: "address2" from Customer
      - `city` string, required: "city" from Customer
      - `country` string, required: "country" from Customer
      - `customerAccountNumber` string: "customerAccountNumber" from Customer
      - `customerCode` string, required: "customerCode" from Customer
      - `customerName` string, required: "customerName" from Customer
      - `exportCode` string: "exportCode" from Customer
      - `importCode` string: "importCode" from Customer
      - `locationCode` string, required: "locationCode" from Customer
      - `retailPricing` string: "retailPricing" from Customer
      - `state` string: "state" from Customer
      - `supplyPricing` string, required: "supplyPricing" from Customer
      - `zipcode` string: "zipcode" from Customer
  - `hasNext` boolean
  - `totalPages` integer

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: customers not found
- `429`: Too Many Requests
- `500`: Unexpected Error
- `504`: Timeout

---

[API](https://skmtc.dev/crunchtime/apis/cruise-platform.md) - [All operations](https://skmtc.dev/crunchtime/apis/cruise-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/cruise-platform/revisions/d6bb0437a907?raw)