WIwithflex
Customers

List customers

Changed on

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

get/v1/customers

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/customers
  • Auth
    HTTP bearer

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
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
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
offsetinteger nullable

Number of objects to skip before returning results.

Example:3
emailstring email nullable

Filter results by customer email address.

Example:john.doe@example.com

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",
      "shipping": {
        "shipping_address_id": "fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
        "line1": "123 Main St",
        "line2": "Suite 100",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94107",
        "country": "US"
      },
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "created_at": "2026-06-15T14:30:00Z",
      "test_mode": false
    }
  ]
}

Changes

  • eec642897a22Revision changes
    • breaking

      the // response's property format changed from email to no format for status

    • warning

      for the query request parameter limit, the max was set to 2147483647.00

    • warning

      for the query request parameter offset, the max was set to 2147483647.00

    • warning

      for the query request parameter limit, the min was set to -2147483648.00

    • warning

      for the query request parameter offset, the min was set to -2147483648.00