show

GET /api/v1/accounts/:account_id/customers/:id

Show a customer

Returns detailed information about a single customer, including all of their enrolled loyalty cards with stamp progress and wallet pass URLs (apple_wallet_url and google_wallet_url) for each card. Also includes metadata and external_references so you can sync state with external systems.

Parameters

Name Type Required Description
account_id Must be a number. Required

Store (account) ID
id Must be a number. Required

Customer ID

Error Codes

Code Description
401 Unauthorized – invalid or missing API token
404 Store or customer not found

Returns

Code: 200

A customer, including their enrolled loyalty cards

Name Type Required Description
id Must be a Integer Required

Unique customer ID
account_id Must be a Integer Required

Parent store ID
first_name Must be a String Required

First name
last_name Must be a String Required

Last name

(nil allowed)
email Must be a String Required

Email address, unique per store

(nil allowed)
phone Must be a String Required

Phone number, unique per store

(nil allowed)
birthday Must be a String Required

Birthday as YYYY-MM-DD

(nil allowed)
stamp_count Must be a Integer Required

Total stamps across every card
metadata Must be a Hash Required

Free form per customer data

(nil allowed)
external_references Must be an Array of nested elements Required

Links to records in other systems
external_references[source] Must be a String Required

External system slug, for example ‘square’
external_references[external_id] Must be a String Required

Identifier of the record in that system
external_references[metadata] Must be a Hash Required

Free form data stored against this reference

(nil allowed)
customer_cards Must be an Array of nested elements Required

Cards this customer is enrolled on
customer_cards[id] Must be a Integer Required

Customer card ID
customer_cards[card_id] Must be a Integer Required

Loyalty card template ID
customer_cards[card_name] Must be a String Required

Name of the loyalty card
customer_cards[stamps_count] Must be a Integer Required

Stamps collected so far
customer_cards[status] Must be a String Required

Current state of the customer card
customer_cards[uuid] Must be a String Required

Public identifier used in wallet pass URLs
customer_cards[apple_wallet_url] Must be a String Required

Link to add or view the pass in Apple Wallet
customer_cards[google_wallet_url] Must be a String Required

Link to add or view the pass in Google Wallet
created_at Must be a String Required

ISO 8601 creation timestamp
updated_at Must be a String Required

ISO 8601 last-update timestamp