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": "2026-04-23T05:09:17.199Z",
      "updatedAt": "2025-06-05T02:07:54.190Z",
      "archivedAt": null,
      "name": "John Doe",
      "email": "john@example.com",
      "id": "customer-6e24b4",
      "metadata": {},
      "integrations": [],
      "defaultPaymentMethod": {
        "type": "CARD",
        "billingId": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6",
        "cardLast4Digits": "1234",
        "cardExpiryMonth": 12,
        "cardExpiryYear": 2025
      },
      "couponId": "coupon-6e24b4"
    }
  ],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-API-KEY
string
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