Get Form Layout

Gets the field layout info of a form in an App.
Method GET
URL https://{subdomain}.kintone.com/k/v1/app/form/layout.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/form/layout.json
Authentication Password Authentication
Content-Type  

Pre-live settings

Apps may hold pre-live settings that have not yet been deployed to the live App.
Access the pre-live settings with the below URL.

URL https://{subdomain}.kintone.com/k/v1/preview/app/form/layout.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/form/layout.json

Permissions

  • Perrmission to view records are needed when obtaining information of live Apps.
  • App Management Permissions are needed when obtaining information of pre-live settings.
  • API Tokens cannot be used with this API.

Request Parameters

Parameter Value Required Description
app String Yes The App ID.

Sample Request

JavaScript (using kintone REST API Request)

XMLHttpRequest

Response Parameters

Parameter Type Description
layout Array A list of field layouts for each row.
layout[].type String The type of row
  • ROW: A normal row of fields.
  • SUBTABLE: A Table.
  • GROUP: A Group field.
layout[].code String The field code of the Table or Group field. This parameter will not be returned for other row types.
layout[].fields Array A list of fields in the row.
layout[].fields[].type String The type of field.
  • CALC: Calculated
  • CATEGORY: Category
  • CHECK_BOX: Check box
  • CREATED_TIME: Created datetime
  • CREATOR: Created by
  • DATE: Date
  • DATETIME: Date and time
  • DROP_DOWN: Drop-down
  • FILE: Attachment
  • HR: Border
  • LABEL: Label
  • LINK: Link
  • MODIFIER: Updated by
  • MULTI_LINE_TEXT: Text Area
  • MULTI_SELECT: Multi-choice
  • NUMBER: Number, or Look-up *
  • RADIO_BUTTON: Radio button
  • RECORD_NUMBER: Record number
  • RICH_TEXT: Rich text
  • SINGLE_LINE_TEXT: Text, or Look-up *
  • SPACER: Blank space
  • STATUS: Process management status
  • STATUS_ASSIGNEE: Assignee of the Process Management status
  • SUBTABLE: Table
  • TIME: Time
  • UPDATED_TIME: Updated datetime
  • USER_SELECT: User selection
*The type of the Look-up field will be the same type as the Key field it's looking up.
layout[].fields[].code String The field code.
layout[].fields[].label String The text set in the Label field.
Only returned for Label fields.
layout[].fields[].elementId String The element ID of the Space field.
Only returned for Space fields.
layout[].fields[].size Object An object with data of the field's size.
layout[].fields[].size.width String The width of the field in pixels.
layout[].fields[].size.height String The height of the field in pixels, including the height of the field name.
layout[].fields[].size.innerHeight String The height of the field in pixels, excluding the height of the field name.
layout[].layout Array A list of field layouts for each row inside a Group field.
revision String The revision number of the App settings.

Sample Response

Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.