Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/akika/docs/llms.txt

Use this file to discover all available pages before exploring further.

These APIs return information about the current app’s configuration — including its ID, form fields, views, process management settings, and permissions. Most are read-only and available in both desktop and mobile environments.
App APIs return configuration from the live app. To read configuration from an app in the test environment, ensure you check kintone.app.isTestEnvironment() first.

​
App information

Returns information about the current app.Function
kintone.app.get()
ParametersNone.Return value
PropertyTypeDescription
idstringThe app ID.
namestringThe app name.
descriptionstringThe app description.
spaceIdstring | nullThe space ID the app belongs to, or null.
threadIdstring | nullThe thread ID the app belongs to, or null.
Example
kintone.events.on('app.record.index.show', function(event) {
  var app = kintone.app.get();
  console.log('App name:', app.name);
  return event;
});
Returns the ID of the current app.Function
kintone.app.getId()
ParametersNone.Return value
TypeDescription
number | nullThe app ID, or null if not available on the current page.
Example
var appId = kintone.app.getId();
console.log('App ID:', appId);
Returns whether the current page is using the app’s test environment (preview mode).Function
kintone.app.isTestEnvironment()
ParametersNone.Return value
TypeDescription
booleantrue if running in the test environment; false otherwise.
Example
if (kintone.app.isTestEnvironment()) {
  console.log('Running in test environment — changes are not live.');
}
Returns whether the app is currently in maintenance mode.Function
kintone.app.isMaintenanceMode()
ParametersNone.Return value
TypeDescription
booleantrue if the app is in maintenance mode; false otherwise.
Example
if (kintone.app.isMaintenanceMode()) {
  console.log('App is under maintenance.');
}
Returns the current user’s permissions for the app.Function
kintone.app.getPermissions()
ParametersNone.Return value
PropertyTypeDescription
hasReadPermissionbooleantrue if the user can view records in the app.
hasAddPermissionbooleantrue if the user can create new records.
hasEditPermissionbooleantrue if the user can edit records.
hasDeletePermissionbooleantrue if the user can delete records.
hasImportPermissionbooleantrue if the user can import records.
hasExportPermissionbooleantrue if the user can export records.
Example
kintone.events.on('app.record.index.show', function(event) {
  var perms = kintone.app.getPermissions();
  if (!perms.hasAddPermission) {
    console.log('User cannot add records to this app.');
  }
  return event;
});
Returns URLs for the app’s icon images.Function
kintone.app.getIcons()
ParametersNone.Return value
PropertyTypeDescription
smallstringURL of the small app icon.
mediumstringURL of the medium app icon.
largestringURL of the large app icon.
Example
var icons = kintone.app.getIcons();
console.log('App icon (large):', icons.large);

​
Form configuration

Returns the form field definitions for the current app.Function
kintone.app.getFormFields()
ParametersNone.Return valueReturns an object whose keys are field codes. Each value is a field definition object.
PropertyTypeDescription
typestringThe field type (e.g., "SINGLE_LINE_TEXT", "NUMBER", "DATE").
codestringThe field code.
labelstringThe field label.
requiredbooleanWhether the field is required.
noLabelbooleanWhether the field label is hidden.
Example
kintone.events.on('app.record.index.show', function(event) {
  var fields = kintone.app.getFormFields();
  Object.keys(fields).forEach(function(code) {
    console.log(code, ':', fields[code].type);
  });
  return event;
});
Returns the form layout for the current app, describing the visual arrangement of fields.Function
kintone.app.getFormLayout()
ParametersNone.Return valueReturns an array of layout row objects. Each row contains field elements with their type and field code.
PropertyTypeDescription
typestringLayout element type: "ROW", "SUBTABLE", or "GROUP".
fieldsarrayArray of field layout elements within the row.
Example
kintone.events.on('app.record.detail.show', function(event) {
  var layout = kintone.app.getFormLayout();
  console.log('Form has', layout.length, 'rows.');
  return event;
});

​
Views

Returns the settings of the view currently displayed in the record list.Function
kintone.app.getView()
ParametersNone.Return value
PropertyTypeDescription
idstringThe view ID.
typestringThe view type: "LIST", "CALENDAR", or "CUSTOM".
namestringThe view name.
builtinTypestring | nullFor built-in views, the type identifier; otherwise null.
Available pages
  • Record list
Example
kintone.events.on('app.record.index.show', function(event) {
  var view = kintone.app.getView();
  console.log('Current view:', view.name, '(type:', view.type + ')');
  return event;
});
Returns all views configured for the current app.Function
kintone.app.getViews()
ParametersNone.Return valueReturns an object whose keys are view names. Each value is a view settings object with the same shape as the return value of kintone.app.getView().Available pages
  • Record list
Example
kintone.events.on('app.record.index.show', function(event) {
  var views = kintone.app.getViews();
  Object.keys(views).forEach(function(name) {
    console.log('View:', name, 'ID:', views[name].id);
  });
  return event;
});

​
Queries

Returns the filter condition string from the current record list view query, without the ORDER BY, LIMIT, or OFFSET clauses.Function
kintone.app.getQueryCondition()
ParametersNone.Return value
TypeDescription
string | nullThe filter condition (e.g., "Status = \"Open\""), or null if not available.
Available pages
  • Record list
Example
kintone.events.on('app.record.index.show', function(event) {
  var condition = kintone.app.getQueryCondition();
  console.log('Active filter:', condition);
  return event;
});
Returns the full query string for the current record list, including ORDER BY, LIMIT, and OFFSET clauses.Function
kintone.app.getQuery()
ParametersNone.Return value
TypeDescription
string | nullThe full query string, or null if not available.
Available pages
  • Record list
Example
kintone.events.on('app.record.index.show', function(event) {
  var query = kintone.app.getQuery();
  // Example: 'Status = "Open" order by $id asc limit 20 offset 0'
  console.log('Full query:', query);
  return event;
});
Returns the app ID of the target app for a Lookup field.Function
kintone.app.getLookupTargetAppId(fieldCode)
Parameters
ParameterTypeRequiredDescription
fieldCodestringYesThe field code of the Lookup field.
Return value
TypeDescription
number | nullThe app ID of the Lookup target app, or null if the field is not a Lookup.
Example
var targetAppId = kintone.app.getLookupTargetAppId('CustomerLookup');
console.log('Lookup target app ID:', targetAppId);
Returns the app ID of the target app for a Related Records field.Function
kintone.app.getRelatedRecordsTargetAppId(fieldCode)
Parameters
ParameterTypeRequiredDescription
fieldCodestringYesThe field code of the Related Records field.
Return value
TypeDescription
number | nullThe app ID of the Related Records target app, or null if the field is not a Related Records field.
Example
var relatedAppId = kintone.app.getRelatedRecordsTargetAppId('RelatedOrders');
console.log('Related records app ID:', relatedAppId);

​
Process management

Returns the process management settings for the current app, including all configured statuses and their transitions.Function
kintone.app.getStatus()
ParametersNone.Return value
PropertyTypeDescription
enablebooleantrue if process management is enabled for the app.
statesobjectAn object whose keys are status names, each containing status configuration.
actionsarrayAn array of action objects describing available status transitions.
Returns null if process management is not enabled for the app.
Example
kintone.events.on('app.record.detail.show', function(event) {
  var status = kintone.app.getStatus();
  if (status && status.enable) {
    console.log('Process management is active.');
    console.log('Available statuses:', Object.keys(status.states));
  }
  return event;
});
Returns the process management actions available to the current user for the record displayed on the page.Function
kintone.app.record.getStatusActions()
ParametersNone.Return valueReturns an array of action objects.
PropertyTypeDescription
namestringThe action name as displayed in the UI.
valuestringThe status the record will move to when this action is taken.
Available pages
  • Record detail
Example
kintone.events.on('app.record.detail.show', function(event) {
  var actions = kintone.app.record.getStatusActions();
  actions.forEach(function(action) {
    console.log('Action:', action.name, '-> Status:', action.value);
  });
  return event;
});
Returns the current assignees for the process management step of the record displayed on the page.Function
kintone.app.record.getAssignees()
ParametersNone.Return valueReturns an array of assignee objects.
PropertyTypeDescription
codestringThe login name of the assignee.
namestringThe display name of the assignee.
Available pages
  • Record detail
Example
kintone.events.on('app.record.detail.show', function(event) {
  var assignees = kintone.app.record.getAssignees();
  assignees.forEach(function(user) {
    console.log('Assignee:', user.name, '(' + user.code + ')');
  });
  return event;
});

​
Categories

Returns the categories configured for the current app.Function
kintone.app.getCategories()
ParametersNone.Return value
PropertyTypeDescription
enablebooleantrue if categories are enabled for the app.
categoriesarrayAn array of category name strings.
Returns null if categories are not enabled for the app.
Example
kintone.events.on('app.record.index.show', function(event) {
  var cats = kintone.app.getCategories();
  if (cats && cats.enable) {
    console.log('Categories:', cats.categories);
  }
  return event;
});

Build docs developers (and LLMs) love

Get started for freeTalk to us