Scopes

Scopes steuern, auf welche API-Bereiche ein OAuth-Client zugreifen darf. Du vergibst Scopes beim Erstellen eines API-Zugangs in den Offisy-Einstellungen.

Die Einrichtung eines API-Zugangs ist im Help Center beschrieben.

Verfügbare Scopes

Scope	Label	Beschreibung	Freigeschaltete Endpoints
full_access	Vollzugriff	Zugriff auf alle Endpoints	Alle
appointments	Termine	Termine abrufen und buchen. Für GET /appointments und GET /appointments/{uuid} ist immer zusätzlich users erforderlich. Für Kurs-Termine (mit Attendees und Kursleitern) zusätzlich customers.	GET /appointments, GET /appointments/{uuid}, GET /booking/available-slots, GET /booking/available-slots/batch, GET /booking/available-slots/next, POST /appointments/service
customers	Kunden	Kunden abrufen, erstellen, bearbeiten	GET /customers, GET /customers/{uuid}, POST /customers, PUT /customers/{uuid}
services	Leistungen	Leistungen abrufen	GET /services, GET /services/{uuid}, GET /service/categories, GET /service/categories/{uuid}
company	Unternehmen	Unternehmensprofil und Mandanten abrufen	GET /company, GET /tenancies, GET /tenancies/{uuid}
locations	Standorte	Standorte abrufen	GET /locations, GET /locations/{uuid}
users	Mitarbeiter	Mitarbeiter abrufen	GET /users, GET /users/{uuid}
executions	Leistungszuordnungen	Leistungszuordnungen abrufen — welche Mitarbeiter welche Leistung an welchem Standort anbieten	GET /executions
medicals	Abrechnungsleistungen	Abrechnungsleistungen abrufen, erstellen und bearbeiten	GET /medicals, GET /medicals/{uuid}, POST /medicals, PUT /medicals/{uuid}

Hinweis: Ein Client mit dem Scope full_access besteht jede Scope-Prüfung automatisch — unabhängig davon, welcher Scope am jeweiligen Endpoint gefordert wird.