List customers

GET/v1/customers

Query Parameters

Results are paged. When has_more is true, pass next_cursor from the response as cursor to fetch the next page.

limitinteger
Default 25. Maximum 100.
cursorstring
external_idstring
Find the customer with this external_id (0 or 1 results)

Responses

200Page of Customer
Customers, newest first
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

idstring
Example: cus_a1B2c3D4e5F6g7.
objectcustomer
namestring
Nullable.
external_idstring
Nullable.
metadataobject
created_atstring (date-time)
updated_atstring (date-time)
phone_numbersarray of string
Only on retrieve

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429
Rate limit or quota exceeded

import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

const customers = await sms.customers.list({ limit: 10 });

Response 200

{
  "data": [
    {
      "id": "cus_a1B2c3D4e5F6g7",
      "object": "customer"
    }
  ],
  "has_more": true,
  "next_cursor": null
}