Skip to main content
GET
/
v1
/
customers
List Customers
curl --request GET \
  --url https://api.withflex.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
      "first_name": "John",
      "last_name": "Doe",
      "email": "joh.doe@example.com",
      "phone": "+15555555555",
      "employer": "Flex",
      "shipping": {},
      "metadata": {},
      "created_at": "2024-01-01T00:00:00Z",
      "test_mode": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
starting_after
string | null

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:

"obj_01EXAMPLE00000000000000000"

​
ending_before
string | null

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:

"obj_01EXAMPLE00000000000000000"

​
limit
integer<int32> | null

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

Example:

10

​
offset
integer<int32> | null

Number of objects to skip before returning results.

Example:

0

​
email
string<email> | null

Filter results by customer email address.

Example:

"john.doe@example.com"

Response

Success

​
customers
object[]
required