Get Apps
Gets general information of multiple Apps, including the name, description, related Space, creator and updater information.
The maximum number of Apps that can be retrieved at one time is 100.
Method | GET |
---|---|
URL | https://{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-Type | application/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 or String | The App IDs. Integers from 1 to 9,223,372,036,854,775,807 can be specified. Up to 100 IDs can be specified. If null or an empty array is specified, this parameter will be ignored. |
|
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. If null or an empty array is specified, this parameter will be ignored. |
|
name | String | The App Name or a part of it. Each App Name must be specified within 64 characters. 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. If null or an empty array is specified, this parameter will be ignored. |
||
spaceIds | Array | Integer or String | The Space ID of where the App resides in. Integers from 1 to 9,223,372,036,854,775,807 can be specified. Up to 100 IDs can be specified. If null or an empty array is specified, this parameter will be ignored. |
|
limit | Integer or String | The number of Apps to retrieve. Must be between 1 and 100. If nothing is specified, it will default to 100. |
||
offset | Integer or String | The number of retrievals that will be skipped. Must be between 0 and 2,147,483,647. If nothing is specified, it will default to 0. |
Sample Request
|
|
XMLHttpRequest
|
|
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
|
|
Limitations
Note that only published Apps can be retrieved.