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 Javno Read tasks owner, user, member, limited_user, guest, admin
tasks.write Delno omejeno Create or update tasks owner, user
projects.read Javno Create or update projects owner, user, member, limited_user, guest, admin
projects.write Delno omejeno Create or update tasks owner, user
appointmets.read Javno Create or update appointments owner, user, member, limited_user, guest, admin
appointmets.write Delno omejeno Create or update appointments owner, user
contacts.read Javno Read contact data owner, user, member, limited_user, guest, admin
contacts.write Omejeno Create or update contacts owner
companies.read Javno Read company data owner, user, member, limited_user, guest, admin
companies.write Omejeno Create or update companies owner
deals.read Javno Read deal data owner, user, member, limited_user, guest, admin
deals.write Omejeno Create or update deals owner
quotes.read Javno Read quote data owner, user, member, limited_user, guest, admin
quotes.write Omejeno Create or update quotes owner
orders.read Javno Read order data owner, user, member, limited_user, guest, admin
orders.write Omejeno Create or update orders owner
services.read Javno Read service data owner, user, member, limited_user, guest, admin
services.write Omejeno Create or update services owner
products.read Javno Read product data owner, user, member, limited_user, guest, admin
products.write Omejeno Create or update products owner
tickets.read Javno Read tickets data owner, user, member, limited_user, guest, admin
tickets.write Omejeno Create or update tickets owner
documents.read Javno Read document data owner, user, member, limited_user, guest, admin
campaigns.read Javno 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

Začnite delati in prihranite čas.

ali
Rezerviraj predstavitev

Potrebujete pomoč?