Get Form
Retrieves the form details of an App.
Attention
This API URL path only supports the retrieval of form data. Also check the Get Form Fields API and the Get Form Layout APIs. These APIs have similar functionalities to the Get Form API, but also support related Update methods. Kintone Config Helper is also a tool developers can use for retrieving field information from Apps.
Contents
Get Form - GET /form.json
Retrieves the form details of an app.
This includes details such as field names, field settings, default values etc.
URI
https://{subdomain}.kintone.com/k/v1/form.json
URI for Guest Space Apps
https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/form.json
Request Parameters
PARAMETER | VALUE | REQUIRED | DESCRIPTION |
---|---|---|---|
app | Integer | Yes | The App ID. |
Sample Request
Sample Request using Query Strings
Send the "app" parameter as an HTTP query string.
Query String
|
|
Request Header
|
|
Sample Request using JSON
Request Header
|
|
Body
|
|
Sample Response
Field properties of each field in the apps are returned as JSON data.
|
|
Response Parameters
PROPERTY NAME | key | VALUES | SAMPLE |
---|---|---|---|
Field Name | label | String (will not be empty) | "label": "title" |
Field Code | code | String (will not be empty) | "code": "field code" |
Element ID | elementId | String (will not be empty) | "elementId": "Space" |
Field Type | type | The TYPE listed in the "Properties retrieved by each field" table below. | "type": "CHECK_BOX" |
Hide field name | noLabel | "true" or "false" | "noLabel": "true" |
Required Field | required | "true" or "false" | "required": "true" |
Prohibit duplicate values | unique | "true" or "false" | "unique": "true" |
Limits of Value | maxValue | Integer or null | "maxValue": "1" |
minValue | Integer or null | "minValue": "100" |
|
Number of Characters | maxLength | Integer or null | "maxLength": "5" |
minLength | Integer or null | "minLength": "2" |
|
Default Value | defaultValue | String or Empty String or null | "defaultValue": "this is the default" If several default values can be set, an array with those values will be returned |
Default Value(time related) | defaultExpression | "NOW" or null | "defaultExpression": "NOW" If the " Default to the record creation date." setting is turned on, "NOW" will be returned. In this case, defaultValue will be NULL. |
Options(for fields with selections) | options | Array of Strings(will not be an empty string) | "options": ["A","B","C"] |
Formula | expression | String or "" | "expression": "price * amount" Formulas are written with field codes. |
Use thousands separators | digit | "true" or "false" | "digit": "true" |
Type(Link) | protocol |
|
"protocol": "WEB" |
Show As | format |
|
"format": "NUMBER" |
Number of Decimal Places | displayScale | The number of decimal places or null | "displayScale": "4" |
Hide formula | hideExpression | "true" or "false" | "hideExpression": "false" |
Datasource App ID (for Lookup, Related Records) | relatedApp | Integer or null (null if you don't have permission to manage the Datasource App) |
"relatedApp": "123" |
Fields within tables | fields | Array | "fields": [ |
Currency | unit | String or null (if not set) | "unit": "$" |
Prefix/Suffix | unitPosition | "BEFORE" (Prefix) "AFTER" (Suffix) The default is set to "Before". |
"unitPosition": "BEFORE" |
Properties retrieved by each field
FIELD TYPE | TYPE | PROPERTIES THAT ARE RETRIEVED |
---|---|---|
Label | LABEL |
|
Single-line text | SINGLE_LINE_TEXT or NUMBER (Depends on the settings of the Lookup field) |
|
Number | NUMBER |
|
Calculated | CALC |
|
Multi-line text | MULTI_LINE_TEXT |
|
Rich text | RICH_TEXT |
|
Check box | CHECK_BOX |
|
Radio button | RADIO_BUTTON |
|
Drop-down | DROP_DOWN |
|
Multi-choice | MULTI_SELECT |
|
Attachment | FILE |
|
Date | DATE |
|
Time | TIME |
|
Date and time | DATETIME |
|
Link | LINK |
|
Blank Space | SPACER |
|
Border | HR |
|
User selection | USER_SELECT |
|
Department Selection | ORGANIZATION_SELECT |
|
Group Selection | GROUP_SELECT |
|
Lookup | SINGLE_LINE_TEXT |
|
Related Records | REFERENCE_TABLE |
|
Record number | RECORD_NUMBER |
|
Created by | CREATOR |
|
Created datetime | CREATED_TIME |
|
Updated by | MODIFIER |
|
Updated datetime | UPDATED_TIME |
|
Table | SUBTABLE |
|
Fields that cannot be retrieved
- Categories
- Status
- Field Group
- The following fields if inside of a field group:
- Automatically generated fields (Record number, Created by, Created datetime, Updated by, Updated datetime), Blank space, Label, Border
JavaScript Samples
Kintone REST API Request Example
|
|
XMLHttpRequest Example
|
|
Get Form Preview - GET /preview/form.json
Retrieves the form details of an app that is still undergoing changes, and the changes have not been applied.
URI
https://{subdomain}.kintone.com/k/v1/preview/form.json
URI for Guest Space Apps
https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/form.json
Request parameters and response properties are the same as the Get Form API.
JavaScript Samples
Kintone REST API Request Example
|
|
XMLHttpRequest Example
|
|
Limitations
- You must have permission to manage the app.
Note
This document mistakenly stated that this API was to be deprecated in the future.
There is no plan yet for the deprecation of this API. We apologize for inconveniences this may have caused for our Kintone developers.