--- title: "Returns reference master data required to build member management UIs" method: GET path: "/ocapi/v1/loyalty-master-data" tags: ["Loyalty"] --- # Returns reference master data required to build member management UIs `GET /ocapi/v1/loyalty-master-data` #### Licenses Required - Vista.Ocapi ## Headers - `Connect-Region-Code` string ## Response `200` Success - OcapiV1LoyaltyMasterDataLoyaltyMasterData — Represents the master data typically used for creating or updating a member - `clubs` OcapiV1LoyaltyClubsClub[], required — Gets the list of club entities available to a member - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `customPreferences` OcapiV1LoyaltyMasterDataCustomPreferencesCustomPreference[], required — Gets the list of custom preference entities used for setting member custom preference entities - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `optionQuantityLimit` OcapiV1QuantityLimit, required — Represents a limited or unlimited quantity - `isUnlimited` boolean, required — Gets a value indicating whether the quantity is unlimited - `maximum` integer, nullable — Gets the maximum quantity allowed - `minimum` integer, required — Gets the minimum quantity allowed (0 by default) - `options` OcapiV1LoyaltyMasterDataCustomPreferencesCustomPreferenceOption[], required — Gets the list of custom preference option entities - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `educationLevels` OcapiV1LoyaltyMasterDataEducationLevelsEducationLevel[], required — Gets the list of education level entities used for setting member personal details EducationLevelId - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `genres` OcapiV1LoyaltyMasterDataGenresLoyaltyGenre[], required — Gets the list of loyalty genre entities used for setting member genre preferences - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `interests` OcapiV1LoyaltyMasterDataInterestsInterest[], required — Gets the list of interest entities used for setting member interest subscription InterestId - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `displayPriority` integer, required — Gets the display priority used for sorting - `interestContactMethods` OcapiV1LoyaltyMasterDataInterestsInterestContactMethod[], required — Gets the list of interest contact method entities used for setting member interest subscription InterestContactMethodIds - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `occupations` OcapiV1LoyaltyMasterDataOccupationsOccupation[], required — Gets the list of occupation entities used for setting member personal details OccupationId - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `photoRequirements` OcapiV1LoyaltyMasterDataPhotosMemberPhotoRequirements, required — Represents the upload requirements for a member photo - `dimensions` OcapiV1LoyaltyMasterDataPhotosMemberPhotoDimensions, required — Represents the exact required dimensions of a member photo - `width` integer, required — Gets the required width in pixels - `height` integer, required — Gets the required height in pixels - `maximumFileSizeInKilobytes` integer, required — Gets the maximum allowed file size in kilobytes - `minimumDaysBetweenUpdates` integer, required — Gets the minimum number of days allowed between photo updates - `sites` OcapiV1LoyaltyMasterDataSitesLoyaltySite[], required — Gets the list of loyalty site entities used for setting member site preferences - `location` OcapiV1GeographicLocation — Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a location on a map - `latitude` number, double, required — Gets the latitude (expressed in degrees and minutes) - `longitude` number, double, required — Gets the longitude (expressed in degrees and minutes) - `contactDetails` OcapiV1BrowsingMasterDataSitesSiteContactDetails, required — Represents the contact details of a site - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities - `type` 'Home' | 'Mobile' | 'Work' | 'Business' | 'Fax', required — Represents the type of a phone number - `number` string, required — Gets the phone number - `email` string, nullable — Gets the email address - `address` OcapiV1BrowsingMasterDataSitesSiteAddress — Represents the physical address of a site - `line1` string, nullable — Gets the first line - `line2` string, nullable — Gets the second line - `city` string, nullable — Gets the city - `ianaTimeZoneName` string, required — Gets the IANA time zone name - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `hasSellableItems` boolean, required — Gets a value indicating whether the site has any sellable item entities - `allowedItemDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `friendConfiguration` OcapiV1LoyaltyMasterDataFriendsMemberFriendConfiguration, required — Represents the configuration for the member friend functionality - `isSubscriptionSharingRestrictedToActiveSubscribers` boolean, required — Gets a value indicating whether the member friend subscription sharing functionality is restricted to member entities with an active member subscription - `friendLimit` OcapiV1Quantity, required — Represents a limited or unlimited quantity - `isUnlimited` boolean, required — Gets a value indicating whether the quantity is unlimited - `value` integer, nullable — Gets the value - `externalAuthenticationIssuers` OcapiV1LoyaltyMasterDataAuthenticationExternalAuthenticationIssuer[], required — Gets the list of external authentication issuer entities that can be used to authenticate Loyalty members without requiring them to create a password for Loyalty - `id` string, required — Gets the identifier of the external authentication issuer --- [API](https://skmtc.net/vista/apis/vista-digital-platform.md) · [All operations](https://skmtc.net/vista/apis/vista-digital-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vista/vista-digital-platform/revisions/3a81c0aed14e/schema)