---
title: "List of customers"
method: GET
path: "/api/v1/customers"
tags: ["Customer"]
---

# List of customers

`GET /api/v1/customers`

Returns the list of customers

## Query parameters

- `page` number
- `limit` number
- `createdAt` DateFilterDto
  - `isnull` boolean — Returns null values
  - `notnull` boolean — Returns not null values
  - `gt` string, date-time — Returns values greater than the given date
  - `gte` string, date-time — Returns values greater than or equal to the given date
  - `lt` string, date-time — Returns values less than the given date
  - `lte` string, date-time — Returns values less than or equal to the given date
- `ids` string
- `visibility` string
- `email` string
- `customerReferenceId` string

## Response `200`

- object
  - `page` number, required — Page number. Starts from 1
  - `limit` number, required — Number of items per page
  - `count` number, required
  - `hasMore` boolean, required
  - `query` PaginationFilterDto
    - `page` number — Page number. Starts from 1
    - `limit` number — Number of items per page
    - `createdAt` DateFilterDto
      - `isnull` boolean — Returns null values
      - `notnull` boolean — Returns not null values
      - `gt` string, date-time — Returns values greater than the given date
      - `gte` string, date-time — Returns values greater than or equal to the given date
      - `lt` string, date-time — Returns values less than the given date
      - `lte` string, date-time — Returns values less than or equal to the given date
  - `data` object[], required
    - `name` string — The name
    - `email` string — The email
    - `phone` string — The phone
    - `organizationName` string — The organization name
    - `address` AddressDetailDto
      - `line1` string
      - `line2` string
      - `city` string
      - `state` string
      - `postalCode` string
      - `country` string
    - `id` string, uuid, required — Customer's id
    - `createdAt` string, date-time — Customer's created at
    - `updatedAt` string, date-time — Customer's updated at
    - `customerReferenceId` string — Customer's reference id
    - `shipping` FullAddressDetailDto
      - `name` string — The name
      - `email` string — The email
      - `phone` string — The phone
      - `organizationName` string — The organization name
      - `address` AddressDetailDto
        - `line1` string
        - `line2` string
        - `city` string
        - `state` string
        - `postalCode` string
        - `country` string
    - `taxIds` TaxIdsDto
      - `object` string
      - `data` TaxIdDto[]
        - `id` string, required
        - `createdAt` string, date-time
        - `updatedAt` string, date-time
        - `name` string
        - `value` string
        - `country` string
        - `customerId` string, uuid, required
    - `visibility` string
    - `metadata` object — Customer's metadata
    - `customerNumber` string, required — Customer number assigned by the system

## Other responses

- `500`

---

[API](https://skmtc.net/copperx/apis/copperx-api-2.md) · [All operations](https://skmtc.net/copperx/apis/copperx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/copperx/copperx-api-2/versions/c0bfbc37fb98/schema)