v1

latestOpenAPI 3.0.32026-07-264469137.7 KB
Customers

List customers

Returns a paginated list of your customers, most recent first. Pass search to filter by email or name. See Pagination for how to page through results. Requires the customers:read scope.

get/v1/customers

Query parameters

limitinteger
offsetinteger
searchstring

Search by customer email or name.

Response

Success

Example response

{
  "items": [
    {
      "customer_id": "cust_1a2b3c4d5e6f",
      "email": "jane@example.com",
      "name": "Jane Doe",
      "metadata": {},
      "created_at": "2026-01-24T12:00:00.000Z"
    }
  ]
}