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-17T16:57:41.989Z",
      "updatedAt": "2026-01-23T12:39:02.604Z",
      "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": null,
      "passthrough": {
        "stripe": {
          "billingAddress": {
            "postalCode": "aiunt"
          },
          "paymentMethodId": "civitas caecus acer triduana coerceo tristis hic video aranea thema titulus corrumpo attero utor in demonstro porro comitatus velociter verumtamen arto fuga rem quod versus absorbeo dolores adfectus vobis magnam suffoco clarus video vesper ducimus ea spon",
          "taxIds": [
            {
              "type": "annus dolorum vulticulus caries aeternus tricesimus deinde turbo spes audeo adinventitias tribuo thymbra tabgo autem alius ultio optio nihil non maiores cervus paens atqui adduco antiquus calcar sortitus vereor cupiditas absum vespillo aliqua depopulo com",
              "value": "deripio comis thymum capitulus adversus cimentarius vulariter tempora curis theca odit assentator civis laudantium attonbitus comis velut claro reprehenderit sapiente aeger tenetur tam occaecati avarus benigne sponte veritas doloremque amet vociferor utro"
            }
          ],
          "invoiceCustomFields": {
            "defero vulariter animadverto bellicus cena adhaero truculenter cibo aestas ": "assum",
            "spoliatio fuga cogito cubo molestiae bardus utrimque iure decretum earum de": "eos decet cunctatio cruciamentum complectus acquiro crastinus ullam quo vid",
            "tenus decretum calamitas cometes deporto vinco maxime aequitas annus nisi ustulo somnus supellex sint suffoco suus cunctatio curo alter sto excepturi arca suscipio comptus admoveo cimentarius strenuus aequitas creptio defero officiis quidem ipsa vado error baiulus et curis ad comparo cogo maiores utpote nisi aedificium clarus soluta hic antepono thymum aranea numquam tantum sum solitudo suscipit strenuus adfectus similique casus subseco supellex peior artificiose abutor cuppedia defessus vicissitudo blandior cribro curo vomer stips abstergo provident cras vitiosus tero ambulo deorsum at uberrime omnis absens territo comminor cernuus agnosco corrumpo curriculum attonbitus odio debeo somniculosus natus conduco bibo tersus ademptio summopere consequatur eligendi umerus delectatio facere tergeo aliqua voco temporibus comes crapula cruentus eligendi addo ultio valens tristis consequuntur arx corrupti recusandae amita aestas ago adinventitias thymbra arma aestivus conforto blandior sperno ab": "tabes"
          }
        },
        "zuora": {
          "billingAddress": {
            "country": "viriliter comprehendo arguo vesco solus depromo altus suffoco curriculum ab",
            "line2": "certus dolores vilitas corrigo demulceo statim pel sursum non capto accedo turpis alias caput acies aggredior cavus paulatim defungo colo sophismata verus utique aestivus amaritudo terga tardus acervus audacia alveus delectatio vitae ancilla blanditiis cornu adhuc amiculum modi tutis valens carpo blanditiis bardus adaugeo volup pauci tener synagoga tamen cruentus admitto cribro decumbo carmen ter caste delego peccatus curo vaco virtus vindico coruscus summopere tenax color solvo acsi alter ullus facilis considero ventito terror approbo antea bis bonus calamitas tibi audacia commodi aer utique theca tremo abstergo veritas cultura dolorem approbo deripio viduo tolero quas appello crur comparo crastinus taceo stultus artificiose theca triumphus conventus benigne adulatio cibo vereor patior coniecto degenero cuius coaegresco aduro accusantium adficio capio dedecor ex atrocitas supplanto acsi ter tutis tabula una tero tego stips verecundia sub denuo cognomen dedecor tabula coaegresco repudi"
          }
        }
      }
    }
  ],
  "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

Maximum string length: 255
​
name
string

Filter by exact customer name

Maximum string length: 255
​
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