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

Zacznij pracować, oszczędzając czas.

lub
Zarezerwuj demo

Potrzebujesz pomocy?