List Customers - Chariow Developers

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": "john@example.com",
        "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": []
}

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": "john@example.com",
        "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.

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

Show properties

data

array

Array of customer objects

Show customer object

string

Unique customer identifier (e.g., cus_abc123xyz)

name

string

Customer full name (combination of first and last name)

first_name

string

Customer first name

last_name

string

Customer last name

string

Customer email address

avatar_url

string

URL to the customer’s avatar image

phone

object

Customer phone number

Show phone object

number

string

International formatted phone number (e.g., +1 234 567 890)

country

object

Country information

Show country object

name

string

Country name

code

string

ISO 3166-1 alpha-2 country code

alpha_3_code

string

ISO 3166-1 alpha-3 country code

dial_code

string

Country dial code

currency

string

Country currency code

flag

string

Country flag emoji

store

object

Store information

Show store object

string

Store public ID

name

string

Store name

logo_url

string

Store logo URL

url

string

Store URL

created_at

string

ISO 8601 timestamp of when the customer was created

updated_at

string

ISO 8601 timestamp of when the customer was last updated

pagination

object

Cursor pagination metadata

Show pagination object

next_cursor

string

Cursor for the next page (null if no more pages)

prev_cursor

string

Cursor for the previous page (null if on first page)

has_more

boolean

Whether there are more pages available

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": "john@example.com",
        "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": []
}

Get Sale Get Customer

​Query Parameters

​Response

Query Parameters

Response