v1

latestOpenAPI 3.1.02026-07-26141236.8 KB

Customers

Retrieve a customer

Retrieves a single customer by ID.

get/customers/{id}

Path parameters

idinteger required

ID of the customer (in Smile) to retrieve.

Query parameters

include'vip_status' | 'vip_status.vip_tier' | 'vip_status.next_vip_tier'

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

Response

The customer was successfully retrieved.

Example response

{
  "customer": {
    "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",
      "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"
  }
}