kintone developer network

Get App

Follow

Get AppGET /app.json

Retrieves details of 1 app.
URI
https://{subdomain}.kintone.com/k/v1/app.json
URI for Guest Space Apps
https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app.json

Request Parameters

PARAMETER VALUE REQUIRED DESCRIPTION
id Integer Yes The app ID of the app you want to target.

Sample Request using Query Strings

HTTP Query String

id=4

Request Header

GET /k/v1/app.json HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=
Authorization: Basic a2ludG9uZTpkZXZlbG9wZXI=

The content-type header is not needed.

Sample Request using JSON

Header

GET /k/v1/app.json HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=
Authorization: Basic a2ludG9uZTpkZXZlbG9wZXI=
Content-Type: application/json

Specify application/json for the Content-Type.

Body

{  
    "id":"4"
}

Sample Response

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

Properties

PARAMETER VALUE DESCRIPTION
appId String The App ID of the kintone application.
code String The App Code of the app. This will be blank if an App Code is not set in the App's settings.
name String The name of the App. If Localization settings are used, it will return the localized name dependant on the language settings of the kintone user using this API.
description String The description of the App. If Localization settings are used, it will return the localized app description dependant on the language settings of the kintone user using 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. For users who have not altered their User Interface Settings to the classic design, apps will automatically belong to the first thread of the space when the app is made in the space. Users who use the classic design will find that they can create apps that are thread-specific instead of space-specific.
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. Nothing is returned for inactive users and deleted users.
creator.name String The display name of the creator. Nothing 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. Nothing is returned for inactive users and deleted users.
modifier.name String The display name of the last updater. Nothing is returned for inactive users and deleted users.

Get AppsGET /apps.json

Retrieves details of multiple apps.
URI
https://{subdomain}.kintone.com/k/v1/apps.json
URI for Guest Space Apps
https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/apps.json

Request Parameters

PARAMETER TYPE VALUE WITHIN THE ARRAY EMPTY ARRAY REQUIRED DESCRIPTION
ids Array Integer Allow Optional The App IDs. Upto 100 IDs can be specified.
Each ID must be an integer between 1 and 9223372036854775807.
This parameter will be ignored if it is null, or contains an empty array.
codes Array String Allow Optional The App Code. Upto 100 App Codes can be sepcified.
Each App Code must be between 1 to 64 characters.
An exact match search will be used, and will be case sensitive.
This parameter will be ignored if it is null, or contains an empty array.
name String     Optional 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.
This parameter will be ignored if it is null, or contains an empty array.
spaceIds Array Integer Allow Optional The Space ID of where the app resides in. Upto 100 IDs can be specified.
Each ID must be an integer between 1 and 9223372036854775807.
This parameter will be ignored if it is null, or contains an empty array.
limit Integer     Optional The number of Apps to retrieve.
Must be between 1 and 100.
If nothing is specified, it will default to 100.
offset Integer     Optional The number of retrievals that will be skipped.
Must be between 0 and 2147483647. If nothing is specified, it will default to 100.

Sample Request using Query Strings

Join each parameter with an "&" For example, let's say we're looking for apps that have an App Code of "task" or "IDEA", that also includes the string "test" in the App Name.

HTTP Query String

name=test&codes[0]=task&codes[1]=IDEA

Request Header

GET /k/v1/apps.json?name=test&codes[0]=task&codes[1]=IDEA HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=
Authorization: Basic a2ludG9uZTpkZXZlbG9wZXI=

The content-type header is not needed.

Sample Request using JSON

Header

GET /k/v1/apps.json HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=
Authorization: Basic a2ludG9uZTpkZXZlbG9wZXI=
Content-Type: application/json

Body

{  
    "codes":[  
        "task",
        "IDEA"
    ],
    "name":"test"
}

Sample Response

Successful Response

{  
    "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"
            }
        }
    ]
}

Bad Response

{  
    "apps":[]
}

Limitations

  • The Get App and Get Apps API will only retrieve details of apps if you have permission to view them.
  • Upto 100 records can be retrieved with the Get Apps API
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Comments