Skip to main content
These APIs return information about the Kintone system environment — including which features are available on the current instance, what the current user is permitted to do at the system level, and whether the subscription is in trial mode.
System APIs are available on both desktop and mobile.

​
Available features

Returns the features available on the current Kintone instance.Function
kintone.system.getAvailableFeatures()
ParametersNone.Return valueReturns an object whose keys are feature identifiers. Each value is a boolean indicating whether the feature is available.Common feature keys include:
Feature keyDescription
portalThe Kintone portal.
spaceSpaces.
peopleKintone People (social features).
notesNotes in spaces.
fileFile management.
presenceUser presence indicators.
Example
kintone.events.on('app.record.index.show', function(event) {
  var features = kintone.system.getAvailableFeatures();
  if (features.space) {
    console.log('Spaces are enabled on this instance.');
  }
  if (features.people) {
    console.log('Kintone People is available.');
  }
  return event;
});
Use this API before calling space or people APIs to gracefully handle instances where those features are disabled.

​
System permissions

Returns the current user’s system-level permissions.Function
kintone.system.getPermissions()
ParametersNone.Return value
PropertyTypeDescription
hasAdminPermissionbooleantrue if the user is a Kintone system administrator.
hasUsersAdminPermissionbooleantrue if the user is a Users and System Administrator.
Example
kintone.events.on('app.record.index.show', function(event) {
  var sysPerms = kintone.system.getPermissions();
  if (sysPerms.hasAdminPermission) {
    console.log('Current user is a Kintone system administrator.');
  }
  return event;
});

​
License

Returns whether the current Kintone subscription is in trial mode.Function
kintone.license.isTrial()
ParametersNone.Return value
TypeDescription
booleantrue if the instance is on a trial subscription; false for paid subscriptions.
Example
kintone.events.on('app.record.index.show', function(event) {
  if (kintone.license.isTrial()) {
    console.log('Running on a Kintone trial. Some features may be limited.');
  }
  return event;
});
Trial accounts may have restrictions on the number of users, storage, or available features. Use this API to conditionally adapt your customization behavior.

Build docs developers (and LLMs) love

Get started for freeTalk to us