Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Customers

List customers

Returns a list of your customers, sorted by ID in descending order (most recently created first). Deleted customers are excluded.

get/v1/customers

Query parameters

starting_afterstring nullable

A cursor for use in pagination. starting_after is a customer ID that defines your place in the list. For instance, if you make a list request and receive 20 customers, ending with cus_xyz, your subsequent call can include starting_after=cus_xyz to fetch the next page.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. starting_after is a customer ID that defines your place in the list. For instance, if you make a list request and receive 20 customers, ending with cus_xyz, your subsequent call can include starting_after=cus_xyz to fetch the next page.

ending_beforestring nullable

A cursor for use in pagination. ending_before is a customer ID that defines your place in the list. For instance, if you make a list request and receive 20 customers, starting with cus_abc, your subsequent call can include ending_before=cus_abc to fetch the previous page.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. ending_before is a customer ID that defines your place in the list. For instance, if you make a list request and receive 20 customers, starting with cus_abc, your subsequent call can include ending_before=cus_abc to fetch the previous page.

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

emailstring email nullable

Filter results by customer email address.

Example:john.doe@example.com

Filter results by customer email address.

Response

An envelope wrapping a list of customer objects.

Example response

{
  "customers": [
    {
      "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
      "owner_partner_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "first_name": "John",
      "last_name": "Doe",
      "email": "joh.doe@example.com",
      "phone": "+15555555555",
      "employer": "Flex",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "created_at": "2026-06-15T14:30:00Z",
      "test_mode": false
    }
  ]
}