Customer

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"bd4a0997-39db-41d9-883a-cdfa83e2101f"
encryptedIdstringEncrypted identifier. Used to create direct checkout links. It has been encrypted with a key for the organization."Wn6VsJflvjBO3YyC0lgXdBt9QKcLVZQ2qkEcvJGqa+Txg+mHI/TWbEuUpS45VZgg"
createdAtstringTimestamp when the customer was created"2024-01-15T09:30:00.000Z"
updatedAtstringTimestamp when the customer was last updated"2024-01-15T09:30:00.000Z"
firstNamestringnullFirst name of customer"Johanna"
lastNamestringnullLast name of customer"Ha"
emailstringnullEmail of customer. Email is unique and trying to create a new customer with an email that already exists will fail"hello@hello.com"
phonestringnullPhone number of customer"12345678"
phoneCountryCodestringnullCountry code of phone number"dk"
memberNumbernumbernullMember number of customer. This will only be issued if the customer at some point has had a membership12345678
addressstringnullAddress of customer"Hovedgaden 1"
address2stringnullAddress 2 of customer"1. sal"
postalCodestringnullPostal code of customer"1234"
citystringnullCity of customer"København"
countrystringnullCountry code of customer address"DK"
birthdatestringnullBirth date for the customer formatted YYYY-MM-DD"2024-01-04"
birthyearnumbernullBirth year for the customer if you only have this information2000
avatarstring (UUIDv4)nullId of the image used for the avatar"bd4a0997-39db-41d9-883a-cdfa83e2101f"
preferredLanguagestringPreferred language of the customer as an ISO 639-1 code. Always present: falls back to the organization's default language when the customer has none"da"
notestringnullOptional internal note"This customer is awesome"
qrCodestringnullQR code of the customer"https://www.acme-museum.com/?qr=KLkjndfjf..."
hasActiveMembershipbooleanWhether the customer holds at least one active membership (see memberships). Present on list and get.true
membershipsarray[]The memberships the customer holds (customerId is this customer), not deleted, newest validTo first. On get, each membership includes changeLog. Memberships where the customer is only the partner (secondaryCustomerId) are not listed.[]
paidMembershipsarray[]The memberships the customer paid for (payerId is this customer), not deleted, newest validTo first, without changeLog. customerId on each is the holder. In Loby, the customer's page lists them under Paid. A membership the customer both holds and paid for is in both lists. Present on list and get. See Holder, partner and payer on Membership[]

List and get also accept ?includeBarcodes=true. When set, the response includes barcodes (id, data) and physicalCards (id, globalNumber, localNumber, qrCode).

Museum custom customer fields appear as extra keys: the field's UUID maps to its value. Date custom fields are YYYY-MM-DD.

initials, gender, occupation, and nationality are accepted on create and update. They are not currently returned on Customer responses.

‹ Previous
Event Types
Next ›
Membership Type