Skip to main content
GET
https://api.chariow.com/v1
/
customers
curl -X GET "https://api.chariow.com/v1/customers?per_page=20&search=john" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "cus_abc123xyz",
        "name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
        "phone": {
          "number": "+1 234 567 890",
          "country": {
            "name": "United States",
            "code": "US",
            "alpha_3_code": "USA",
            "dial_code": "+1",
            "currency": "USD",
            "flag": "🇺🇸"
          }
        },
        "store": {
          "id": "str_xyz789",
          "name": "My Digital Store",
          "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
          "url": "https://mystore.chariow.link"
        },
        "created_at": "2025-01-15T10:30:00+00:00",
        "updated_at": "2025-01-20T14:45:00+00:00"
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}
Retrieves a cursor-paginated list of all customers in your store. Customers are created automatically when they make a purchase. This endpoint supports search filtering and date range filtering.

​
Query Parameters

​
per_page
integer
default:"15"
Number of customers to return per page (max 100)
​
cursor
string
Cursor for pagination. Use the next_cursor from the previous response.
​
search
string
Search customers by name, email, or phone number
​
start_date
string
Filter customers created from this date (Y-m-d format, e.g., 2025-01-01)
​
end_date
string
Filter customers created until this date (Y-m-d format, e.g., 2025-01-31)

​
Response

​
data
object
curl -X GET "https://api.chariow.com/v1/customers?per_page=20&search=john" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "cus_abc123xyz",
        "name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
        "phone": {
          "number": "+1 234 567 890",
          "country": {
            "name": "United States",
            "code": "US",
            "alpha_3_code": "USA",
            "dial_code": "+1",
            "currency": "USD",
            "flag": "🇺🇸"
          }
        },
        "store": {
          "id": "str_xyz789",
          "name": "My Digital Store",
          "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
          "url": "https://mystore.chariow.link"
        },
        "created_at": "2025-01-15T10:30:00+00:00",
        "updated_at": "2025-01-20T14:45:00+00:00"
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}