Retrieves details of 1 record from an App by specifying the App ID and Record ID.
Request Parameters
PARAMETER |
VALUE |
REQUIRED |
DESCRIPTION |
app |
Integer or String |
Yes |
The App ID. |
id |
Integer or String |
Yes |
The Record ID. |
Sample Requests (Query string)
Query String
1
|
https://{subdomain}.kintone.com/k/v1/record.json?app=20&id=100
|
JavaScript (using
1
2
3
4
5
6
7
|
kintone.api(kintone.api.url('/k/v1/record.json', true) + '?app=20&id=100', 'GET', {}, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});
|
curl Sample
1
2
|
curl -X GET 'https://{subdomain}.kintone.com/k/v1/record.json?app=20&id=100' \
-H 'X-Cybozu-API-Token: {APIToken}'
|
Sample Requests (JSON)
JavaScript (using
1
2
3
4
5
6
7
8
9
10
11
12
|
var body = {
'app': 20,
'id': 100
};
kintone.api(kintone.api.url('/k/v1/record.json', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});
|
curl Sample
1
2
3
4
|
curl -X GET 'https://{subdomain}.kintone.com/k/v1/record.json' \
-H 'X-Cybozu-API-Token: {APIToken}' \
-H 'Content-Type: application/json' \
-d '{"app": 20, "id": 100}'
|
Response Parameters
Parameter |
Type |
Description |
record |
Object |
The type and value of all fields within the record are included in the object. |
Sample Response
A record object of fields that exist in the specified App are responded.
Each field information includes the field type and value(s) stored in the specified record of the App.
Check the
field types documentation for more details on each field type.
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
46
|
{
"record": {
"Updated_datetime": {
"type": "UPDATED_TIME",
"value": "2019-03-11T04:50:00Z"
},
"Created_datetime": {
"type": "CREATED_TIME",
"value": "2019-03-11T04:50:00Z"
},
"Number": {
"type": "NUMBER",
"value": "1"
},
"Record_number": {
"type": "RECORD_NUMBER",
"value": "1"
},
"Text": {
"type": "SINGLE_LINE_TEXT",
"value": "sample"
},
"Created_by": {
"type": "CREATOR",
"value": {
"code": "Administrator",
"name": "Administrator"
}
},
"$revision": {
"type": "__REVISION__",
"value": "1"
},
"Updated_by": {
"type": "MODIFIER",
"value": {
"code": "Administrator",
"name": "Administrator"
}
},
"$id": {
"type": "__ID__",
"value": "1"
}
}
}
|
Get Multiple Records
To retrieve data of multiple records, refer to
the Get Records API article.
Notes
- The language of the returned record data depends on the method of authentication used:
- When the
Accept-Language
request header is specified, the specified language will be returned, if it has been set in the locale settings.
- API Token authentication: The Administrator account's display language will be used.
- Other forms of authentication: The user account's display language will be used.
- When the display language is set to Use Web browser settings, the language specified in the Users and Systems Administration locale setting will be used.
- The system locale can be changed via the Users and Systems Administration
Locale Settings
.