Skip to main content
GET
/
v1
/
customers
/
{customerId}
Get Customer
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "cust_T849EgzNVVmn5icJ2FAkT2rO",
  "source_id": "alice.morgan@email.com",
  "name": "Alice Morgan",
  "email": "alice.morgan@email.com",
  "address": null,
  "summary": {
    "redemptions": {
      "total_redeemed": 2,
      "total_failed": 0,
      "total_succeeded": 2,
      "total_rolled_back": 0,
      "total_rollback_failed": 0,
      "total_rollback_succeeded": 0,
      "gift": {
        "redeemed_amount": 0,
        "amount_to_go": 0
      },
      "loyalty_card": {
        "redeemed_points": 0,
        "points_to_go": 3303
      }
    },
    "orders": {
      "total_amount": 203900,
      "total_count": 2,
      "average_amount": 101950,
      "last_order_amount": 3900,
      "last_order_date": "2022-07-26T14:59:52.814Z"
    }
  },
  "loyalty": {
    "points": 3303,
    "referred_customers": 0,
    "campaigns": {
      "Summer Campaign": {
        "points": 3303,
        "referred_customers": 0
      }
    }
  },
  "referrals": {
    "total": 0,
    "campaigns": []
  },
  "system_metadata": {},
  "created_at": "2022-02-07T08:28:23.644Z",
  "updated_at": "2022-07-26T14:59:59.806Z",
  "assets": {
    "cockpit_url": "{{internalVoucherifyURL}}"
  },
  "object": "customer"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

customerId
string
required
Example:

Response

summary
object
required
loyalty
object
required
referrals
object
required
object
enum<string>
default:customer
required
Available options:
customer
id
string
source_id
string
system_metadata
object
created_at
string<date-time>
Example:
updated_at
string<date-time>
Example:
assets
object
name
string
description
string
email
string
phone
string
birthday
string<date>
birthdate
string<date>
address
object | null
metadata
object