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

組織を取得する

目次

組織を取得する

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

組織情報を取得します。
一度に取得できる組織は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]=Sales01&ids[1]=Sales02

ヘッダー
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

{
  "organizations": [
    {
      "id": "1",
      "code": "Sales01",
      "name": "国内営業部",
      "localName": "Domestic Sales Department",
      "localNameLocale": "en",
      "parentCode": "Sales00",
      "description": "国内営業部"
    },
    {
      "id": "2",
      "code": "Sales02",
      "name": "海外営業部",
      "localName": "International Sales Department",
      "localNameLocale": "en",
      "parentCode": "Sales00",
      "description": "海外営業部"
    }
  ]
}

サンプルコード

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

curlを使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/v1/organizations.json?codes%5B0%5D=Sales01&codes%5B1%5D=Sales02' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='