Skip to main content
GET
Get program membership

Authorizations

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

Path Parameters

programId
string
required

Unique loyalty program ID (format lprg_[a-f0-9]+).

Pattern: ^lprg_[a-f0-9]+$
customerId
string
required

Unique identifier of the customer or member, interpreted according to identification_type: a Voucherify customer ID (cust_...), a customer source_id, or a loyalty member ID (lmbr_...).

Query Parameters

identification_type
enum<string>
default:customer_id

Chooses how customerId is read. customer_id is the Voucherify customer ID and the default. customer_source_id is the customer's source_id. member_id is the loyalty member ID.

Available options:
customer_id,
customer_source_id,
member_id

Response

The membership in the program.

Response body schema for GET /v2/loyalties/programs/{programId}/memberships/{customerId}.

member
object
required

The loyalty program member.

program
object
required

The loyalty program the member belongs to.

object
string
required

Object type marker, always membership.

Allowed value: "membership"
cards
object[]
required

Member's loyalty cards, one per card definition assigned to the program. tier_progress is present when that card definition has a tier structure and the member has a tier on the card. Otherwise it is omitted. card.code can be null right after member creation, while code generation is still running.