組織を取得する

目次

組織を取得する

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

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

URL

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

HTTP メソッド

GET

必要なアクセス権

なし

リクエスト

パラメーター
パラメーター名 必須 説明
ids 配列 省略可 組織 ID の一覧
codes は同時に指定できません。
idscodes のどちらも省略すると、最大 100 件の組織情報を取得します。
codes 配列 省略可 組織コードの一覧
ids は同時に指定できません。
idscodes のどちらも省略すると、最大 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='