Last updated

Scopes

Scopes are used to limit the access of an application to specific resources or actions within the API. They are defined in the OpenAPI specification and can be used to control what an application can do with the API.

ScopeDescription
ADDITIONAL_INFORMATION_READAllows partner to read additional information data
ADDITIONAL_INFORMATION_WRITEAllows partner to write additional information data
AGGREGATOR_MEMBER_WRITEAllows partner to write aggregator member data
APPOINTMENTS_READAllows partner to read appointments data
APPOINTMENTS_WRITEAllows partner to write appointments data
BOOKABLE_APPOINTMENTS_READAllows partner to read bookable appointments data
CHECKIN_READAllows partner to read checkin data
CHECKIN_VOUCHER_WRITEAllows partner to write checkin voucher data
CLASSES_READAllows partner to read classes data
CLASSES_WRITEAllows partner to write classes data
COMMUNICATION_PREFERENCES_READAllows partner to read communication preferences data
COMMUNICATION_PREFERENCES_WRITEAllows partner to write communication preferences data
COMMUNICATION_WRITEAllows partner to write communication data
CUSTOMER_ACCESS_MEDIUM_WRITEAllows partner to write customer access medium data
CUSTOMER_ACCESS_RESTRICTION_WRITEAllows partner to write customer access restriction data
CUSTOMER_ACCOUNT_READAllows partner to read customer account data
CUSTOMER_ACCOUNT_WRITEAllows partner to write customer account data
CUSTOMER_BENEFIT_READAllows partner to read customer benefit data
CUSTOMER_BENEFIT_WRITEAllows partner to write customer benefit data
CUSTOMER_CONTRACT_READAllows partner to read customer contract data
CUSTOMER_DOCUMENT_WRITEAllows partner to write customer document data
CUSTOMER_MEASUREMENT_READAllows partner to read customer measurement data
CUSTOMER_READAllows partner to read customer related data
CUSTOMER_SELF_SERVICE_READAllows partner to read customer self service data
CUSTOMER_SELF_SERVICE_WRITEAllows partner to write customer self service data
CUSTOMER_WEIGHING_WRITEAllows partner to write customer weighing data
CUSTOMER_WRITEAllows partner to write customer related data
DEBT_COLLECTION_READAllows partner to read debt collection data
DEBT_COLLECTION_WRITEAllows partner to write debt collection data
DEVICE_READAllows partner to read device data
DEVICE_WRITEAllows partner to write device data
EMPLOYEE_READAllows partner to read employee data
MEMBERSHIP_READAllows partner to read membership data
MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_CONTRACT_READAllows partner to read membership self service additional module contract data
MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_CONTRACT_WRITEAllows partner to write membership self service additional module contract data
MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_READAllows partner to read membership self service additional module data
MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_CONFIG_READAllows partner to read membership self service idle period config data
MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_READAllows partner to read membership self service idle period data
MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_WRITEAllows partner to write membership self service idle period data
MEMBERSHIP_SELF_SERVICE_READAllows partner to read membership self service data
MEMBERSHIP_SELF_SERVICE_WRITEAllows partner to write membership self service data
MEMBERSHIP_WRITEAllows partner to write membership data
PAYMENT_WRITEAllows partner to write payment information data
STUDIO_READAllows partners to read studio information
STUDIO_WRITEAllows partner to write studio data
TAX_ADVISOR_EXPORT_READAllows partner to read tax advisor export data
TAX_ADVISOR_EXPORT_WRITEAllows partner to write tax advisor export data
TRIAL_OFFER_READAllows partner to read trial offer data
TRIAL_OFFER_WRITEAllows partner to write trial offer data