Mokapen API Documentation

Scopes & Permissions

Scopes control which API resources your application can read or write. Each scope has an access level that maps to organization member roles.

Scope Access level Description Allowed roles
tasks.read Öffentlich Read tasks owner, user, member, limited_user, guest, admin
tasks.write Teilweise eingeschränkt Create or update tasks owner, user
projects.read Öffentlich Create or update projects owner, user, member, limited_user, guest, admin
projects.write Teilweise eingeschränkt Create or update tasks owner, user
appointmets.read Öffentlich Create or update appointments owner, user, member, limited_user, guest, admin
appointmets.write Teilweise eingeschränkt Create or update appointments owner, user
contacts.read Öffentlich Read contact data owner, user, member, limited_user, guest, admin
contacts.write Eingeschränkt Create or update contacts owner
companies.read Öffentlich Read company data owner, user, member, limited_user, guest, admin
companies.write Eingeschränkt Create or update companies owner
deals.read Öffentlich Read deal data owner, user, member, limited_user, guest, admin
deals.write Eingeschränkt Create or update deals owner
quotes.read Öffentlich Read quote data owner, user, member, limited_user, guest, admin
quotes.write Eingeschränkt Create or update quotes owner
orders.read Öffentlich Read order data owner, user, member, limited_user, guest, admin
orders.write Eingeschränkt Create or update orders owner
services.read Öffentlich Read service data owner, user, member, limited_user, guest, admin
services.write Eingeschränkt Create or update services owner
products.read Öffentlich Read product data owner, user, member, limited_user, guest, admin
products.write Eingeschränkt Create or update products owner
tickets.read Öffentlich Read tickets data owner, user, member, limited_user, guest, admin
tickets.write Eingeschränkt Create or update tickets owner
documents.read Öffentlich Read document data owner, user, member, limited_user, guest, admin
campaigns.read Öffentlich Read campaign data owner, user, member, limited_user, guest, admin

How scopes work

When creating an application, you select the scopes it is allowed to request. At runtime, the access token must include the scope required by the endpoint (for example, tasks.read for listing tasks).

For public (third-party) applications, Mokapen also checks that the authenticated user's role in the organization is allowed for each scope level.

  • Public — available to owner, admin, user, member, limited_user, and guest roles.
  • Semi-restricted — available to owner and user roles.
  • Restricted — available to owner role only.

Requesting scopes

Public apps: pass scopes as a space-separated list in the OAuth authorize URL and token request.

Private apps: scopes are taken from the application configuration when generating a token.

scope=tasks.read tasks.write contacts.read companies.read

Effizienz beginnt hier!

oder
Demo buchen

Brauchen Sie Hilfe?