Scopes

Scopes control which API areas an OAuth client is allowed to access. You assign scopes when creating an API access in the Offisy settings.

Setting up API access is described in the Help Center.

Available scopes

Scope	Label	Description	Unlocked endpoints
full_access	Full access	Access to all endpoints	All
appointments	Appointments	Retrieve and book appointments. GET /appointments and GET /appointments/{uuid} always require users in addition. For course appointments (with attendees and instructors) additionally customers.	GET /appointments, GET /appointments/{uuid}, GET /booking/available-slots, GET /booking/available-slots/batch, GET /booking/available-slots/next, POST /appointments/service
customers	Customers	Retrieve, create, and update customers	GET /customers, GET /customers/{uuid}, GET /customers/last-opened, POST /customers, PUT /customers/{uuid}, GET /customer-values, GET /customer-values/{uuid}, POST /customer-values
notices	Notes	Read and create customer notes	GET /customer-notices, GET /customer-notices/{uuid}, POST /customer-notices
services	Services	Retrieve services	GET /services, GET /services/{uuid}, GET /service/categories, GET /service/categories/{uuid}
company	Company	Retrieve company profile and tenants	GET /company, GET /tenancies, GET /tenancies/{uuid}
locations	Locations	Retrieve locations	GET /locations, GET /locations/{uuid}
users	Users	Retrieve users	GET /users, GET /users/{uuid}
executions	Service assignments	Retrieve service assignments — which users offer which service at which location	GET /executions
medicals	Medical data	Read and create medical patient data	Fee note services: GET /fee-note-services, GET /fee-note-services/{uuid}, POST /fee-note-services, PUT /fee-note-services/{uuid}; Diagnoses: GET /diagnoses, GET /diagnoses/{uuid}, POST /diagnoses; Evidences: GET /evidences, GET /evidences/{uuid}, POST /evidences; Long-term medications: GET /long-term-medications, GET /long-term-medications/{uuid}, POST /long-term-medications; Sports exemptions: GET /sports-exemptions, GET /sports-exemptions/{uuid}, POST /sports-exemptions; Referrals: GET /referrals, GET /referrals/{uuid}, POST /referrals; Incoming referrals: GET /incoming-referrals, GET /incoming-referrals/{uuid}, POST /incoming-referrals; Regulations: GET /regulations, GET /regulations/{uuid}, POST /regulations; Visit confirmations: GET /visit-confirmations, GET /visit-confirmations/{uuid}, POST /visit-confirmations; Doctor letters: GET /doctor-letters, GET /doctor-letters/{uuid}, POST /doctor-letters; Patient letters: GET /patient-letters, GET /patient-letters/{uuid}, POST /patient-letters; Transports: GET /transports, GET /transports/{uuid}, POST /transports; Lab results: GET /lab-results, GET /lab-results/{uuid}, POST /lab-results; Illness notifications: GET /illness-notifications, GET /illness-notifications/{uuid}, POST /illness-notifications; Health notifications: GET /health-notifications, GET /health-notifications/{uuid}, POST /health-notifications; Files: GET /files, GET /files/{uuid}, GET /files/{uuid}/download, POST /files
invoices	Invoices	Retrieve invoices, cash revenues, and fee notes	GET /invoices, GET /invoices/{uuid}, GET /cash-revenues, GET /cash-revenues/{uuid}, GET /fee-notes, GET /fee-notes/{uuid}

Note: A client with the full_access scope passes every scope check automatically — regardless of which scope is required at a given endpoint.