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

# getCustomersByPage

`GET /customer/v1/getCustomersByPage`

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.net/crunchtime/apis/inventory-labor.md) · [All operations](https://skmtc.net/crunchtime/apis/inventory-labor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crunchtime/inventory-labor/revisions/0af8e380ff2c/schema)