API Docs

Get Record Details

Get Record Details - kintone.app.record.get()

Retrieves record data of the currently open record in JSON format.

Function

Desktop

kintone.app.record.get()

Mobile

kintone.mobile.app.record.get()

Parameters

None

Returns

  • An object with record details, or null.
  • Null is returned for pages where it cannot be used.
  • If the API is used on the Record Create or Record Edit page, the returned data will include the current edited data.
  • Attachment file data is already converted to an empty array on the Record Create and Record Edit pages.
  • Invalid values in the Number field will return #INVALID!.

Sample Request 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

var record = kintone.app.record.get();
console.log(record);

// returns
// {
//     "record": {
//         "updated_time": {
//             "type": "UPDATED_TIME",
//             "value": "2018-03-15T09:22:00Z"
//         },
//         "creator": {
//             "type": "CREATOR",
//             "value": {
//                 "code": "john-d",
//                 "name": "John Doe"
//             }
//         },
//         "radiobutton_0": {
//             "type": "RADIO_BUTTON",
//             "value": "January"
//         },
//         "created_time": {
//             "type": "CREATED_TIME",
//             "value": "2018-02-15T09:22:00Z"
//         },
//         "record_id": {
//             "type": "RECORD_NUMBER",
//             "value": "1"
//         },
//         "updater": {
//             "type": "MODIFIER",
//             "value": {
//                 "code": "john-d",
//                 "name": "John Doe"
//             }
//         },
//         "checkbox": {
//             "type": "CHECK_BOX",
//             "value": [
//                 "Sunday",
//                 "Monday"
//             ]
//         }
//     }
// }

Available Pages (Desktop)

  • Record Details
  • Record Create
  • Record Edit
  • Record Print

Available Pages (Mobile)

  • Record Details
  • Record Create
  • Record Edit

Notes

  • kintone.app.record.get and kintone.mobile.app.record.get cannot be called in the kintone.events.on handler. If you need to retrieve record data in the event handler, utilize the event object, as that has the record data inside.