Skip to main content
Use these endpoints to create apps, deploy configuration changes, and check deployment status. All requests require authentication.
Changes made through preview endpoints (/k/v1/preview/...) are saved as a draft and do not affect the live app until you call Deploy App Settings. After deploying, use Get App Deploy Status to confirm the deployment completed.

​
App management

Returns the details of a single app.

​
Query parameters

ParameterTypeRequiredDescription
idIntegerYesThe app ID.

​
Response properties

PropertyTypeDescription
appIdStringThe app ID.
codeStringThe app code.
nameStringThe app name.
descriptionStringThe app description.
spaceIdStringThe ID of the space the app belongs to, or null.
threadIdStringThe ID of the thread the app belongs to, or null.
createdAtStringISO 8601 timestamp of when the app was created.
creatorObjectThe creator’s code and name.
modifiedAtStringISO 8601 timestamp of the last modification.
modifierObjectThe last modifier’s code and name.

​
Examples

curl -X GET 'https://{subdomain}.kintone.com/k/v1/app.json?id=1' \
  -H 'X-Cybozu-Authorization: {AuthorizationCode}'
Sample response
{
  "appId": "1",
  "code": "APP_CODE",
  "name": "My App",
  "description": "An example Kintone app.",
  "spaceId": null,
  "threadId": null,
  "createdAt": "2022-01-01T00:00:00.000Z",
  "creator": { "code": "user1", "name": "User One" },
  "modifiedAt": "2022-06-01T00:00:00.000Z",
  "modifier": { "code": "user1", "name": "User One" }
}
Returns a list of apps. Supports filtering by IDs, codes, name, or space. Returns up to 100 apps per request.

​
Query parameters

ParameterTypeRequiredDescription
ids[]Array of integersNoFilter by app IDs. Up to 100 values.
codes[]Array of stringsNoFilter by app codes. Up to 100 values.
nameStringNoFilter by app name (partial match).
spaceIds[]Array of integersNoFilter by space IDs. Up to 100 values.
offsetIntegerNoNumber of apps to skip. Default: 0.
limitIntegerNoNumber of apps to return. Max: 100. Default: 100.

​
Response properties

PropertyTypeDescription
appsArrayList of app objects. Each object contains the same properties as Get App.

​
Examples

curl -X GET 'https://{subdomain}.kintone.com/k/v1/apps.json?ids[]=1&ids[]=2&limit=10' \
  -H 'X-Cybozu-Authorization: {AuthorizationCode}'
Sample response
{
  "apps": [
    {
      "appId": "1",
      "code": "APP_CODE",
      "name": "My App",
      "description": "An example Kintone app.",
      "spaceId": null,
      "threadId": null,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "creator": { "code": "user1", "name": "User One" },
      "modifiedAt": "2022-06-01T00:00:00.000Z",
      "modifier": { "code": "user1", "name": "User One" }
    }
  ]
}

​
Creating and deploying apps

Creates a new app in preview (draft) state. The app is not live until you call Deploy App Settings.

​
Request body

ParameterTypeRequiredDescription
nameStringYesThe app name. Maximum 64 characters.
spaceIntegerNoThe ID of the space to place the app in.
threadIntegerNoThe ID of the thread in the space. Required if space is specified.

​
Response properties

PropertyTypeDescription
appStringThe ID of the newly created app.
revisionStringThe revision number of the app settings.

​
Examples

curl -X POST 'https://{subdomain}.kintone.com/k/v1/preview/app.json' \
  -H 'X-Cybozu-Authorization: {AuthorizationCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My New App",
    "space": 5,
    "thread": 10
  }'
Sample response
{
  "app": "23",
  "revision": "1"
}
Deploys the draft settings of one or more apps, making them live. You can deploy up to 300 apps per request.
Deployment is asynchronous. After calling this endpoint, use Get App Deploy Status to confirm the deployment has completed before proceeding.

​
Request body

ParameterTypeRequiredDescription
appsArray of objectsYesList of apps to deploy. Each object contains app (app ID) and optionally revision.
apps[].appIntegerYesThe app ID.
apps[].revisionIntegerNoThe expected revision number. Deployment fails if the current revision does not match. Use -1 to skip the check.
revertBooleanNoIf true, reverts all draft settings back to the live settings without deploying. Default: false.

​
Response

An empty object {} is returned on success.

​
Examples

curl -X POST 'https://{subdomain}.kintone.com/k/v1/preview/app/deploy.json' \
  -H 'X-Cybozu-Authorization: {AuthorizationCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "apps": [
      { "app": 23, "revision": 3 }
    ]
  }'
Sample response
{}
Returns the deployment status for one or more apps. Use this after calling Deploy App Settings to confirm deployment completed.

​
Query parameters

ParameterTypeRequiredDescription
apps[]Array of integersYesThe app IDs to check. Up to 300 values.

​
Response properties

PropertyTypeDescription
appsArrayList of status objects.
apps[].appStringThe app ID.
apps[].statusStringDeployment status: PROCESSING, SUCCESS, FAIL, or CANCEL.

​
Examples

curl -X GET 'https://{subdomain}.kintone.com/k/v1/preview/app/deploy.json?apps[]=23' \
  -H 'X-Cybozu-Authorization: {AuthorizationCode}'
Sample response
{
  "apps": [
    {
      "app": "23",
      "status": "SUCCESS"
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us