API Docs

Get Apps

Gets general information of multiple Apps, including the name, description, related Space, creator and updater information.

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

Contents

Permissions

  • Permission to view records or add records is needed.
  • API Tokens cannot be used with this API.

Request Parameters

Parameter Type Value within the array Required Description
ids Array Integer The App IDs.
Up to 100 IDs can be specified.
codes Array String The App Code.
Up to 100 App Codes can be specified.
Each App Code must be between 1 to 64 characters. An exact match search will be used, and will be case sensitive.
name String The App Name.
A partial search will be used, and the search will be case insensitive.
The localized name of the App in the user's locale will also be included in the search.
spaceIds Array Integer The Space ID of where the App resides in.
Up to 100 IDs can be specified.
limit Integer The number of Apps to retrieve.
Must be between 1 and 100.
If nothing is specified, it will default to 100.
offset Integer The number of retrievals that will be skipped.
Must be between 0 and 2147483647. If nothing is specified, it will default to 0.

Sample Request

JavaScript using kintone.api() 

1
2
3
4
5
6
7

kintone.api(kintone.api.url('/k/v1/apps.json', true), 'GET', {}, 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

var url = 'https://{subdomain}.kintone.com/k/v1/apps.json';
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
apps Array of Objects An array of objects that contain general information of Apps.
apps[].appId String The App ID.
apps[].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.
apps[].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.
apps[].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.
apps[].spaceId String If the App was created inside a Space, it will return the Space ID. If not, null is returned.
apps[].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.
apps[].createdAt String The date of when the App was created.
apps[].creator Object The information of the user who created the App.
apps[].creator.code String The log in name of the creator.
An empty string is returned for inactive users and deleted users.
apps[].creator.name String The display name of the creator.
An empty string is returned for inactive users and deleted users.
apps[].modifiedAt String The date of when the App was last modified.
apps[].modifier Object The information of the user who last updated the App.
apps[].modifier.code String The log in name of the last updater. An empty string is returned for inactive users and deleted users.
apps[].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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

{
  "apps": [
    {
      "appId": "1",
      "code": "task",
      "name": "My Test App",
      "description": "Testing this app",
      "spaceId": null,
      "threadId": null,
      "createdAt": "2014-06-02T05:14:05.000Z",
      "creator": {
        "code": "user1",
        "name": "user1"
      },
      "modifiedAt": "2014-06-02T05:14:05.000Z",
      "modifier": {
        "code": "user1",
        "name": "user1"
      }
    },
    {
      "appId": "2",
      "code": "IDEA",
      "name": "test app for ideas",
      "description": "",
      "spaceId": "3",
      "threadId": "4",
      "createdAt": "2014-06-03T05:14:05.000Z",
      "creator": {
        "code": "user2",
        "name": "user2"
      },
      "modifiedAt": "2014-06-03T05:14:05.000Z",
      "modifier": {
        "code": "user2",
        "name": "user2"
      }
    }
  ]
}