Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.smile.io/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "id": 304169228,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@doe.com",
      "state": "member",
      "date_of_birth": "1004-05-27",
      "points_balance": 300,
      "referral_url": "http://i.refs.cc/9qr5Pw",
      "vip_tier_id": 426715794,
      "vip_status": {
        "vip_tier_id": 426715794,
        "vip_tier_expires_at": "2026-12-31T23:59:59.999Z",
        "progress_value": 300,
        "current_vip_period_end": "2025-12-31T23:59:59.999Z",
        "delta_to_retain_vip_tier": 123,
        "next_vip_tier_id": 426715799,
        "delta_to_next_vip_tier": 200
      },
      "created_at": "2024-04-04T15:10:42.030Z",
      "updated_at": "2025-04-04T15:10:42.030Z"
    }
  ],
  "metadata": {
    "next_cursor": "aWQ6MixkaXJlY3Rpb246bmV4dA==",
    "previous_cursor": ""
  }
}
This endpoint requires the scope.
Results are sorted by id in descending order. To lookup customers by email, include the email query parameter. Note however that Smile does not enforce uniqueness on email, so multiple customer records may be returned if they have the same email address.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
email
string

Filter results to only customers with the provided email address.

​
state
enum<string>

Filter results to only customers with the provided state.

Available options:
candidate,
member,
disabled
​
updated_at_min
string<date-time>

Filter results to only customers updated after the provided date and time.

Example:

"2024-04-04T15:10:42.030Z"

​
limit
integer
default:50

The maximum number of customers to retrieve.

Required range: 1 <= x <= 250
Example:

1

​
cursor
string

Cursor for the page of customers to be retrieve.

​
include
enum<string>

A comma-separated list of related objects to include in the response.

Available options:
vip_status

Response

200 - application/json

The customers were successfully retrieved.

​
customers
object[]
​
metadata
object