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

組織を取得する

目次

組織を取得する

組織情報を取得します。
1 度に取得できる組織は 100 件までです。

CSV ファイルをエクスポートする API の詳細は、 組織情報をエクスポートする を参照してください。

URL

https://sample.cybozu.com/v1/organizations.json

HTTP メソッド

GET

必要なアクセス権

なし

リクエスト

パラメーター
パラメーター名 型 必須 説明
ids 配列 省略可 組織 ID の一覧
codes は同時に指定できません。
ids と codes のどちらも省略すると、最大 100 件の組織情報を取得します。
codes 配列 省略可 組織コードの一覧
ids は同時に指定できません。
ids と codes のどちらも省略すると、最大 100 件の組織情報を取得します。
size 数値 省略可 取得する組織の件数
1 から 100 まで指定できます。省略すると 100 が設定されます。
offset 数値 省略可 取得する組織の先頭からスキップする数
0 から無限大の数値を指定できます。
省略すると、 0 が設定されます。
リクエストの例
URL

https://sample.cybozu.com/v1/organizations.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=10

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

レスポンス

プロパティ
プロパティ名 型 説明
organizations 配列 組織情報の一覧
詳細は Organization 型 を参照してください。
並び順は、organizations[].id の昇順です。
レスポンスの例
 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

{
  "organizations": [
    {
      "id": 5,
      "name": "org1",
      "code": "org1",
      "parentCode": "org3",
      "localName": "ln1",
      "localNameLocale": "en",
      "description": "desc1"
    },
    {
      "id": 6,
      "name": "org2",
      "code": "org2",
      "parentCode": "org3",
      "localName": "ln2",
      "localNameLocale": "zh",
      "description": "desc2"
    },
    {
      "id": 7,
      "name": "org3",
      "code": "org3",
      "parentCode": null,
      "localName": "ln3",
      "localNameLocale": "zh",
      "description": "desc3"
    }
  ]
}