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.
Scope | Description |
---|---|
ADDITIONAL_INFORMATION_READ | Allows partner to read additional information data |
ADDITIONAL_INFORMATION_WRITE | Allows partner to write additional information data |
AGGREGATOR_MEMBER_WRITE | Allows partner to write aggregator member data |
APPOINTMENTS_READ | Allows partner to read appointments data |
APPOINTMENTS_WRITE | Allows partner to write appointments data |
BOOKABLE_APPOINTMENTS_READ | Allows partner to read bookable appointments data |
CHECKIN_READ | Allows partner to read checkin data |
CHECKIN_VOUCHER_WRITE | Allows partner to write checkin voucher data |
CLASSES_READ | Allows partner to read classes data |
CLASSES_WRITE | Allows partner to write classes data |
COMMUNICATION_PREFERENCES_READ | Allows partner to read communication preferences data |
COMMUNICATION_PREFERENCES_WRITE | Allows partner to write communication preferences data |
COMMUNICATION_WRITE | Allows partner to write communication data |
CUSTOMER_ACCESS_MEDIUM_WRITE | Allows partner to write customer access medium data |
CUSTOMER_ACCESS_RESTRICTION_WRITE | Allows partner to write customer access restriction data |
CUSTOMER_ACCOUNT_READ | Allows partner to read customer account data |
CUSTOMER_ACCOUNT_WRITE | Allows partner to write customer account data |
CUSTOMER_BENEFIT_READ | Allows partner to read customer benefit data |
CUSTOMER_BENEFIT_WRITE | Allows partner to write customer benefit data |
CUSTOMER_CONTRACT_READ | Allows partner to read customer contract data |
CUSTOMER_DOCUMENT_WRITE | Allows partner to write customer document data |
CUSTOMER_MEASUREMENT_READ | Allows partner to read customer measurement data |
CUSTOMER_READ | Allows partner to read customer related data |
CUSTOMER_SELF_SERVICE_READ | Allows partner to read customer self service data |
CUSTOMER_SELF_SERVICE_WRITE | Allows partner to write customer self service data |
CUSTOMER_WEIGHING_WRITE | Allows partner to write customer weighing data |
CUSTOMER_WRITE | Allows partner to write customer related data |
DEBT_COLLECTION_READ | Allows partner to read debt collection data |
DEBT_COLLECTION_WRITE | Allows partner to write debt collection data |
DEVICE_READ | Allows partner to read device data |
DEVICE_WRITE | Allows partner to write device data |
EMPLOYEE_READ | Allows partner to read employee data |
MEMBERSHIP_READ | Allows partner to read membership data |
MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_CONTRACT_READ | Allows partner to read membership self service additional module contract data |
MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_CONTRACT_WRITE | Allows partner to write membership self service additional module contract data |
MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_READ | Allows partner to read membership self service additional module data |
MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_CONFIG_READ | Allows partner to read membership self service idle period config data |
MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_READ | Allows partner to read membership self service idle period data |
MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_WRITE | Allows partner to write membership self service idle period data |
MEMBERSHIP_SELF_SERVICE_READ | Allows partner to read membership self service data |
MEMBERSHIP_SELF_SERVICE_WRITE | Allows partner to write membership self service data |
MEMBERSHIP_WRITE | Allows partner to write membership data |
PAYMENT_WRITE | Allows partner to write payment information data |
STUDIO_READ | Allows partners to read studio information |
STUDIO_WRITE | Allows partner to write studio data |
TAX_ADVISOR_EXPORT_READ | Allows partner to read tax advisor export data |
TAX_ADVISOR_EXPORT_WRITE | Allows partner to write tax advisor export data |
TRIAL_OFFER_READ | Allows partner to read trial offer data |
TRIAL_OFFER_WRITE | Allows partner to write trial offer data |