Skip to main content
GET
/
api
/
v1
/
customers
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const customerListResponse of client.v1.customers.list()) {
  console.log(customerListResponse.id);
}
{
  "data": [
    {
      "createdAt": "2025-06-01T18:29:57.861Z",
      "updatedAt": "2027-03-11T14:46:26.145Z",
      "archivedAt": null,
      "name": "John Doe",
      "email": "john@example.com",
      "billingId": "cus_MIhJJFnJL24HFH",
      "id": "customer-6e24b4",
      "billingCurrency": null,
      "metadata": {},
      "integrations": [],
      "defaultPaymentMethod": {
        "type": "CARD",
        "billingId": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6",
        "cardLast4Digits": "1234",
        "cardExpiryMonth": 12,
        "cardExpiryYear": 2025
      },
      "couponId": "coupon-6e24b4",
      "timezone": "depraedor curatio perspiciatis distinctio amoveo cotidie clamo aestas deorsum colo thermae rem beatae thymbra viriliter cribro credo stabilis perferendis tametsi aqua tenax nulla arceo admiratio somnus vulgus spiculum officia ulciscor summopere demum cum ",
      "language": null
    }
  ],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Query Parameters

after
string<uuid>

Return items that come after this cursor

before
string<uuid>

Return items that come before this cursor

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
email
string

Filter by exact customer email address

name
string

Filter by exact customer name

createdAt
object

Filter by creation date using range operators: gt, gte, lt, lte

Response

A paginated list of customer objects.

Response list object

data
Customer · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results