List Customers

GET /v1/customers

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customer appearing first.

Request

curl -X GET "https://public.api.levixgas.com/v1/customers" \
     -H "X-API-Key: YYBXbxc.T_x2psVizfd1M3XPIKHEeYYpZkMoH4uJ5LXlicSsV8Y" \
     -d size 100

Parameters

email string optional

A case-sensitive filter on the list based on the customer's email field. The value must be a string.

More Parameters

created_at_gte string optional

ISO for datetime representing the minimum value to filter by (inclusive)

---

created_at_lte string optional

ISO for datetime representing the maximum value to filter by (inclusive)

---

page integer optional

Specifies which page of result to retrieve. The default is 1.

---

size integer optional

This specifies a limit on the number of objects to return, ranging between 1 and 100, and the default is 10.

Returns

A dictionary with a data property that contains an array of up to size customers. Passing an optional email will result in filtering to customers with only the exact email address. Each entry in the array is a separate customer object. If no more customers are available, the resulting array will be empty.

Response

{
  "object":"list",
  "data":[
    {
      "id":"382f9b09-aa08-4bc6-97e3-d9039d5b3422",
      "object":"customer",
      "created_at":"2025-08-13T01:08:44.577Z",
      "email":"jdoe@example.com",
      "is_verified":true,
      "last_seen_at":null,
      "name":"John Doe",
      "phone":null,
      "tank_count":0,
      "updated_at":"2025-08-13T01:08:44.577Z",
      "verified_at":null
    }
  ],
  "page":1,
  "size":10,
  "total_pages":100,
  "total_items":1000
}