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 Public Read tasks owner, user, member, limited_user, guest, admin
tasks.write Semi Create or update tasks owner, user, admin
projects.read Public Read projects owner, user, member, limited_user, guest, admin
projects.write Semi Create or update projects owner, user, admin
appointments.read Public Read appointments owner, user, member, limited_user, guest, admin
appointments.write Semi Create or update appointments owner, user, admin
bookings.read Public Read bookings owner, user, member, limited_user, guest, admin
bookings.write Semi Create or update bookings owner, user, admin
contacts.read Public Read contact data owner, user, member, limited_user, guest, admin
contacts.write Semi Create or update contacts owner, user, admin
companies.read Public Read company data owner, user, member, limited_user, guest, admin
companies.write Semi Create or update companies owner, user, admin
deals.read Public Read deal data owner, user, member, limited_user, guest, admin
deals.write Semi Create or update deals owner, user, admin
quotes.read Public Read quote data owner, user, member, limited_user, guest, admin
quotes.write Semi Create or update quotes owner, user, admin
orders.read Public Read order data owner, user, member, limited_user, guest, admin
orders.write Semi Create or update orders owner, user, admin
services.read Public Read service data owner, user, member, limited_user, guest, admin
services.write Semi Create or update services owner, user, admin
products.read Public Read product data owner, user, member, limited_user, guest, admin
products.write Semi Create or update products owner, user, admin
tickets.read Public Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Semi Create or update tickets owner, user, admin
documents.read Public Read document data owner, user, member, limited_user, guest, admin
documents.write Semi Create or update documents owner, user, admin
campaigns.read Public Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Semi Create or update campaigns owner, user, admin
profile.write Semi Update profile roles and preferences owner, user, admin
users.write Semi Manage teams and team members owner, user, 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 (includes profile.write and users.write for profile and team management).

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

Commencez à travailler le temps d'économie.

ou
Réserver une démo

Besoin d'aide?