API Docs

Get App

Gets general information of an App, including the name, description, related Space, creator and updater information.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/app.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app.json
Authentication Password Authentication, API Token Authentication, Session Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Permissions

Permissions to view the App is needed.

Request Parameters

Parameter Value Required Description
id Integer or String Yes The App ID.

Sample Request

JavaScript (using Kintone REST API Request)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

var body = {
  'id': 1
};
kintone.api(kintone.api.url('/k/v1/app.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

var params = '?id=1';
var url = 'https://{subdomain}.kintone.com/k/v1/app.json' + params;
console.log(url);
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Response Parameters

Parameter Type Description
appId String The App ID.
code String The App Code of the App.
An empty string is returned if an App Code is not set in the App's settings.
name String The name of the App.
If Localization settings are enabled, the localized name will be returned. The localization language will be dependent on the language settings of the Kintone user authenticating this API.
description String The description of the App.
If Localization settings are enabled, the localized name will be returned. The localization language will be dependent on the language settings of the Kintone user authenticating this API.
spaceId String If the App was created inside a Space, it will return the Space ID. If not, null is returned.
threadId String If the App was created inside a Space, it will return the Thread ID of the Thread of the space it belongs to.
Apps that are created inside Spaces using the GUI will be automatically allocated to the default Thread.
If the App was not created in a Space, null is returned.
createdAt String The date of when the App was created.
creator Object The information of the user who created the App.
creator.code String The log in name of the creator.
An empty string is returned for inactive users and deleted users.
creator.name String The display name of the creator.
An empty string is returned for inactive users and deleted users.
modifiedAt String The date of when the App was last modified.
modifier Object The information of the user who last updated the App.
modifier.code String The log in name of the last updater.
An empty string is returned for inactive users and deleted users.
modifier.name String The display name of the last updater.
An empty string is returned for inactive users and deleted users.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "appId": "1",
  "code": "",
  "name": "ToDo App",
  "description": "This is a great app!",
  "spaceId": "2",
  "threadId": "3",
  "createdAt": "2015-03-06T02:24:03.000Z",
  "creator": {
    "code": "user1",
    "name": "User1"
  },
  "modifiedAt": "2015-03-06T03:06:57.000Z",
  "modifier": {
    "code": "login-name",
    "name": "Display Name"
  }
}