---
title: "Get Customers"
method: GET
path: "/customers"
---

# Get Customers

`GET /customers`

Fetches existing customer objects according to query parameters.

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

Customers fetched successfully.

- object
  - `statusCode` integer — Status code of the response. `200` indicates a successful request.
  - `message` string — Human-readable description of the result.
  - `data` object[] — Array of objects for the requested page.
    - `_id` string — Unique identifier of the object.
    - `business` string — Identifier of the business that owns this object.
    - `type` string — Type of the object.
    - `name` string — Display name.
    - `status` string — Current status of the object.
    - `isApproved` boolean — Whether the customer has passed KYC and is approved.
    - `phoneNumber` string — Customer's phone number in international format.
    - `emailAddress` string — Customer's email address.
    - `individual` object — Details for an individual customer.
      - `firstName` string — First name.
      - `lastName` string — Last name.
      - `otherNames` string — Other names, if any.
      - `dob` string — Date of birth (YYYY/MM/DD).
      - `identity` object — Customer's verified identity record.
        - `type` string — Type of the object.
        - `number` string — Identity / card number value.
      - `documents` object — Uploaded KYC document URLs.
        - `idFrontUrl` string — URL of the front of the customer's ID document.
        - `idBackUrl` string — URL of the back of the customer's ID document.
        - `addressVerificationUrl` string — URL of the customer's address verification document.
    - `billingAddress` object — Customer's billing address.
      - `line1` string — Address line 1.
      - `line2` string — Address line 2.
      - `city` string — City.
      - `state` string — State / region.
      - `postalCode` string — Postal / ZIP code.
      - `country` string — Country.
    - `createdAt` string, date-time — ISO 8601 timestamp of when the object was created.
    - `updatedAt` string, date-time — ISO 8601 timestamp of when the object was last updated.
    - `__v` integer — Internal document version (Mongo).
  - `pagination` object — Pagination metadata for the result set.
    - `total` integer — Total number of records matching the query across all pages.
    - `pages` integer — Total number of pages available for the current query.
    - `page` integer — Current page index (zero-based; matches the `page` query parameter).
    - `limit` integer — Maximum number of records returned per page (matches the `limit` query parameter).

## Other responses

- `400` — Validation error — invalid query parameters.
- `401` — Authentication failed — missing or invalid API key.

---

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