Garoon API ドキュメント

組織の一覧を取得する

目次

組織の一覧を取得する

組織の一覧を取得します。

URL

クラウド版

https://sample.cybozu.com/g/api/v1/base/organizations

パッケージ版
Windows 環境
http://サーバーの IP アドレスまたはホスト名/scripts/インストール識別子/grn.exe/api/v1/base/organizations
Linux 環境
http://サーバーの IP アドレスまたはホスト名/cgi-bin/インストール識別子/grn.cgi/api/v1/base/organizations

HTTP メソッド

GET

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 5.0 以降

必要なアクセス権

なし

リクエスト

パラメーター

リクエストパラメーターは、URL クエリパラメーターとして送信してください。
ただし、 Garoon REST API リクエストを送信する API を使って実行する場合は、リクエストボディとして指定できます。

パラメーター名 型 必須 説明
name 文字列 省略可 組織名
limit 数値 省略可 取得する組織の件数
1 から 1,000 まで指定できます。省略すると 100 が設定されます。
指定された条件に一致する組織がさらにある場合でも、指定した値より取得できる組織の数は少なくなる可能性があります。
offset 数値 省略可 取得する組織の先頭からスキップする数
省略すると、 0 が設定されます。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/base/organizations?limit=30

ヘッダー
1
2
3

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

リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を確認してください。

ボディ
1
2
3

{
  "limit": 30
}

レスポンス

プロパティ
プロパティ名 型 説明
organizations[].id 数値 組織 ID
organizations[].name 文字列 組織名
organizations[].code 文字列 組織コード
organizations[].parentOrganization 文字列 親組織 ID
organizations[].childOrganizations.id 数値 子組織 ID
hasNext 真偽値 次の組織情報があるかどうか
  • true：次の組織情報がある
  • false：次の組織情報がない
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "organizations": [
    {
      "id": "5",
      "name": "Development Department",
      "code": "development_department",
      "parentOrganization": "2",
      "childOrganizations": [
        {
          "id": "10"
        }
      ]
    }
  ],
  "hasNext": false
}

サンプルコード

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

curl -X GET 'https://sample.cybozu.com/g/api/v1/base/organizations?limit=30' \ 
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5

const body = {
  limit: 30
};

await garoon.api('/api/v1/base/organizations', 'GET', body);