Sign in
Customers

Retrieve a customer

get/customers/{id}

Path parameters

idinteger required

The SamCart ID for the customer

Query parameters

created_at_minstring date-time

Filter by created at date/time at or after given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 00:00:00 UTC.

created_at_maxstring date-time

Filter by created at date/time at or before given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 23:59:59 UTC.

Response

Successful operation

idinteger

The SamCart ID of the customer

first_namestring nullable

The first name of the customer

last_namestring nullable

The last name of the customer

emailstring email

The email address of the customer

phonestring nullable

The phone number of the customer

lifetime_valueinteger

The lifetime value (in cents) of the customer. Value is for live data only

updated_atstring date-time

The UTC date and time when the customer information was updated

created_atstring date-time

The UTC date and time when the customer was created

Example response

{
  "id": 1337,
  "first_name": "John",
  "last_name": "Doe",
  "email": "jdoe@gmail.com",
  "phone": "5555555555",
  "customer_tags": [
    {
      "name": "new"
    }
  ],
  "lifetime_value": 95025,
  "updated_at": "2020-03-04 00:18:35",
  "created_at": "2020-03-04 00:18:35",
  "addresses": [
    {
      "type": "shipping",
      "street": "221B Baker Street",
      "postal_code": "1234",
      "city": "Austin",
      "state": "TX",
      "region": "Quebec",
      "country": "United States"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.