cybozu.com共通APIドキュメント

組織の所属ユーザーを取得する

目次

組織の所属ユーザーを取得する

固定リンクがコピーされました

組織の所属ユーザーを取得します。

CSVファイルをエクスポートするAPIはありません。

URL

固定リンクがコピーされました

https://sample.cybozu.com/v1/organization/users.json

HTTPメソッド

固定リンクがコピーされました

GET

必要なアクセス権

固定リンクがコピーされました

なし

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
code 文字列 必須 組織コード
size 数値 省略可 取得する所属ユーザーの件数
1から100まで指定できます。省略すると100が設定されます。
offset 数値 省略可 取得する所属ユーザーの先頭からスキップする数
0から無限大の数値を指定できます。
省略すると、0が設定されます。
リクエストの例
URL

https://sample.cybozu.com/v1/organization/users.json?code=Sales01

ヘッダー

APIトークンを利用する場合、指定するスコープにかかわらず実行可能です。

1
2
3

{
  "Authorization": "Bearer API_TOKEN"
}

リクエストヘッダーの詳細は次のページを参照してください。
User APIの共通仕様

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
userTitles 配列 組織の所属ユーザーとその役職の一覧
詳細は次のページを参照してください。
UserTitle型
レスポンスの例
 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

{
  "userTitles": [
    {
      "user": {
        "id": "3",
        "code": "sato-noboru",
        "ctime": "2019-04-01T00:33:58Z",
        "mtime": "2023-03-31T04:00:15Z",
        "valid": true,
        "name": "佐藤 昇",
        "surName": "佐藤",
        "givenName": "昇",
        "surNameReading": "さとう",
        "givenNameReading": "のぼる",
        "localName": "",
        "localNameLocale": "ja",
        "timezone": "Asia/Tokyo",
        "locale": "ja",
        "description": "",
        "phone": "0000-000-0000",
        "mobilePhone": "090-000-0000",
        "extensionNumber": "",
        "email": "sato-noboru@example.com",
        "callto": "",
        "url": "",
        "employeeNumber": "",
        "birthDate": "1991-04-17",
        "joinDate": "2020-04-01",
        "primaryOrganization": "9",
        "sortOrder": null,
        "customItemValues": [
          {
            "code": "boss",
            "value": "2"
          }
        ]
      },
      "title" : {
        "id" : "1",
        "code" : "Manager",
        "name" : "マネージャー",
        "description" : "マネージャー"
      }
    }
  ]
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行 

1
2

curl -X GET 'https://sample.cybozu.com/v1/organization/users.json?code=Sales01' \
  -H 'Authorization: Bearer API_TOKEN'

制限事項

固定リンクがコピーされました

  • kintoneのゲストユーザーは取得できません。