Customer
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
id* | string (UUIDv4) | Unique identifier | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
encryptedId | string | Encrypted identifier. Used to create direct checkout links. It has been encrypted with a key for the organization. | "Wn6VsJflvjBO3YyC0lgXdBt9QKcLVZQ2qkEcvJGqa+Txg+mHI/TWbEuUpS45VZgg" | |
createdAt | string | Timestamp when the customer was created | "2024-01-15T09:30:00.000Z" | |
updatedAt | string | Timestamp when the customer was last updated | "2024-01-15T09:30:00.000Z" | |
firstName | string | null | First name of customer | "Johanna" |
lastName | string | null | Last name of customer | "Ha" |
email | string | null | Email of customer. Email is unique and trying to create a new customer with an email that already exists will fail | "hello@hello.com" |
phone | string | null | Phone number of customer | "12345678" |
phoneCountryCode | string | null | Country code of phone number | "dk" |
memberNumber | number | null | Member number of customer. This will only be issued if the customer at some point has had a membership | 12345678 |
address | string | null | Address of customer | "Hovedgaden 1" |
address2 | string | null | Address 2 of customer | "1. sal" |
postalCode | string | null | Postal code of customer | "1234" |
city | string | null | City of customer | "København" |
country | string | null | Country code of customer address | "DK" |
birthdate | string | null | Birth date for the customer formatted YYYY-MM-DD | "2024-01-04" |
birthyear | number | null | Birth year for the customer if you only have this information | 2000 |
avatar | string (UUIDv4) | null | Id of the image used for the avatar | "bd4a0997-39db-41d9-883a-cdfa83e2101f" |
note | string | null | Optional internal note | "This customer is awesome" |
qrCode | string | null | QR code of the customer | "https://www.acme-museum.com/?qr=KLkjndfjf..." |
hasActiveMembership | boolean | Whether the customer has at least one active membership. Present on list and get. | true | |
memberships | array | [] | Memberships for the customer (not deleted), newest validTo first. On get, each membership includes changeLog. | [] |
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.