API Docs

Data Structures Used with the User API

Contents

ID Type

Used for entities (user/group/department) in Kintone.
An integer between 1 - Long.MAX.

User Type

Key Type Details
id ID Type The user ID. Refer to the following section for more information on ID types:
ID Type
code String The log in name of the User.
ctime ISO-8601 date and time format The created datetime of the User.
mtime ISO-8601 date and time format The updated datetime of the User.
valid Boolean If the Status of the user is Active or not.
name String The display name of the User.
surName String The last name of the User.
givenName String The first name of the User.
surNameReading String The phonetic reading of the Last name.
givenNameReading String The phonetic reading of the First name.
localName String The localized display name of the User.
localNameLocale String The locale of the localized display name of the User.
timezone String The time zone ID of the user's set time zone. See all list of time zones in the Kintone Help:
List of Time Zones (External link)
locale String The language setting of the user.
description String The About Me section of the user's profile.
phone String The phone number of the User.
mobilePhone String The mobile phone number of the User.
extensionNumber String The extension number of the User.
email String The Email address of the User.
callto String The Skype ID of the User.
url String The URL section of the user's profile.
employeeNumber String The Employee Number of the User.
birthDate ISO-8601 date format or null The Birthday of the User.
joinDate ISO-8601 date format or null The Hire Date of the User.
primaryOrganization Integer or null The Department ID of the Priority Department of the User. Set to null if there is no Priority Department.
sortOrder Integer The Display Order priority of the User.
customItemValues customItemValue Arrays A list of pairs of Custom Field Names and Custom Field Codes. Refer to the following section for more information on customItemValues:
customItemValue Type

Sample

 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

{
  "birthDate": "2000-05-01",
  "callto": "",
  "code": "a",
  "ctime": "2024-08-22T08:12:18Z",
  "customItemValues": [
    {
      "code": "item1",
      "value": "aitem1"
    },
    {
      "code": "secret",
      "value": "aitem2"
    }
  ],
  "description": "",
  "email": "",
  "employeeNumber": "",
  "extensionNumber": "",
  "givenName": "",
  "givenNameReading": "",
  "id": "1",
  "joinDate": "2024-08-01",
  "localName": "",
  "localNameLocale": "en",
  "locale": "",
  "mobilePhone": "",
  "mtime": "2024-08-22T09:00:45Z",
  "name": "a",
  "phone": "",
  "primaryOrganization": null,
  "sortOrder": 2147483647,
  "surName": "a",
  "surNameReading": "",
  "timezone": "Asia/Tokyo",
  "url": "",
  "valid": true
}

Department Type

Key Type Details
id ID Type The ID of the Department. Refer to the following section for more information on ID types:
ID Type
code String The Code of the Department.
name String The display name of the Department.
localName String The localized name of the Department.
localNameLocale String The locale of the localized name of the Department.
parentCode String The code of the Parent Department. null, if the parent is the Root.
description String The description of the Department.

Sample

1
2
3
4
5
6
7
8
9

{
  "id": 1,
  "code": "DEV_ba27fP",
  "name": "DEV",
  "localName": "Department of Development Engineering",
  "localNameLocale": "en",
  "parentCode": null,
  "description": "A department dedicated to the company’s development engineering."
}

Title Type

Key Type Details
id ID Type The ID of the Job Title. Refer to the following section for more information on ID types:
ID Type
code String The code of the Job Title.
name String The name of the Job Title.
description String The description of the Job Title.

Sample

1
2
3
4
5
6

{
  "id": 2,
  "code": "Engineer_OLE9N0",
  "name": "Engineer",
  "description": "Engineer"
}

Group Type

Key Type Details
id ID Type The ID of the Group. Refer to the following section for more information on ID types:
ID Type
code String The code of the Group.
name String The display name of the Group.
description String The description of the Group.

Sample

1
2
3
4
5
6

{
  "id": 1,
  "code": "MARKETING01",
  "name": "Tokyo Marketing Department",
  "description": ""
}

OrganizationTitle Type

Key Type Details
organization department type The Department information. Refer to the following section for more information on department types:
Department Type
title title type or null The Job Title information. null for no title. Refer to the following section for more information on title types:
Title Type

Sample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "organization": {
    "id": 1,
    "code": "DEV_ba27fP",
    "name": "DEV",
    "localName": "Department of Development Engineering",
    "localNameLocale": "en",
    "parentCode": null,
    "description": "A department dedicated to the company’s development engineering."
  },
  "title": {
    "id": 2,
    "code": "Engineer_OLE9N0",
    "name": "Engineer",
    "description": "Engineer"
  }
}

UserTitle Type

Key Type Details
user user type The User information. Refer to the following section for more information on user types:
User Type
title title type or null The Job Title information. null for no title. Refer to the following section for more information on user types:
Title Type

Sample

 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

{
  "user": {
    "birthDate": "2000-05-01",
    "callto": "",
    "code": "a",
    "ctime": "2024-08-22T08:12:18Z",
    "customItemValues": [
      {
        "code": "item1",
        "value": "aitem1"
      },
      {
        "code": "secret",
        "value": "aitem2"
      }
    ],
    "description": "",
    "email": "",
    "employeeNumber": "",
    "extensionNumber": "",
  " givenName": "",
    "givenNameReading": "",
    "id": "1",
    "joinDate": "2024-08-01",
    "localName": "",
    "localNameLocale": "en",
    "locale": "",
    "mobilePhone": "",
    "mtime": "2024-08-22T09:00:45Z",
    "name": "a",
    "phone": "",
    "primaryOrganization": null,
    "sortOrder": 2147483647,
    "surName": "a",
    "surNameReading": "",
    "timezone": "Asia/Tokyo",
    "url": "",
    "valid": true
  },
  "title": {
    "id": 2,
    "code": "Engineer_OLE9N0",
    "name": "Engineer",
    "description": "Engineer"
  }
}

CustomItemValue Type

Key Type Details
code String Code
value String Value

Custom fields may have their Visibility option's Make this field public setting unchecked. Only the user themselves and Users & System Administrators are able to get data of Custom Fields that have the Visibility option unchecked.
For more information on custom fields, refer to the following article in the Kintone Help page:
Adding Custom Fields (External link)

Sample

1
2
3
4

{
  "code": "item",
  "value": "item value"
}