Garoon APIドキュメント

組織の一覧を取得する

目次

組織の一覧を取得する

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

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

URL

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

クラウド版

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

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoonのインストール識別子
Windows環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/base/organizations
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/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 配列 組織情報の一覧
並び順はorganizations[].idの昇順です。
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);