---
title: "GET /api/customers"
method: GET
path: "/api/customers"
---

# GET /api/customers

`GET /api/customers`

Retrieve a paginated list of customers based on the provided API key

## Query parameters

- `limit` integer
- `page` integer

## Headers

- `x-api-key` string

## Response `200`

List of customers retrieved successfully

- object
  - `success` boolean
  - `customersData` CustomerObject[]
    - `email` string, email, required — The email of the user or lead. *Must be unique.
    - `firstName` string — The first name of the user or lead.
    - `lastName` string — The last name of the user or lead.
    - `title` string — The user's title (e.g. CEO, CTO, Mr, etc.).
    - `phoneNumber` string — The phone number of the user or lead.
    - `organization` string — The organization of the user or lead (e.g. company name).
    - `website` string — The user's website.
    - `address` string — The user's address.
    - `city` string — The user's city.
    - `state` string — The user's state.
    - `zip` string — The user's zip code.
    - `country` string — The user's country.
    - `billingAddress` string — The user's billing address.
    - `billingCity` string — The user's billing city.
    - `billingState` string — The user's billing state.
    - `billingZip` string — The user's billing zip code.
    - `billingCountry` string — The user's billing country.
    - `subscriptionType` string — The user's subscription type.
    - `socialMediaHandles` object[] — The user's social media handles.
      - `platform` string — The social media platform (e.g. facebook, twitter, tiktok, linkedin, etc.).
      - `handle` string — The user's handle on the social media platform (e.g. johndoe).
    - `notes` string — Any additional notes for the user or lead.
    - `customFields` object[] — The user's custom fields.
      - `name` string — The name of the custom field.
      - `value` string — The value of the custom field.
  - `totalCustomers` integer
  - `currentPage` integer
  - `totalPages` integer

## Other responses

- `401` — No API key provided or invalid API key
- `404` — User not found
- `500` — Internal server error

---

[API](https://skmtc.dev/usersketch/apis/usersketch-api.md) · [All operations](https://skmtc.dev/usersketch/apis/usersketch-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/usersketch/usersketch-api/revisions/d53c94e971a4/schema)