指定された組織に属するユーザーの一覧を取得します。

クラウド版

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

パッケージ版

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

• 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/ORGANIZATION_ID/users

Linux環境

http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/base/organizations/ORGANIZATION_ID/users

パスパラメーター

GET

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

なし

パラメーター

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

リクエストの例

URL

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

ヘッダー

1
2
3

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

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

ボディ

1
2
3

{
  "limit": 30
}

プロパティ

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "users": [
    {
      "id": "1",
      "name": "User1",
      "code": "user1"
    }
  ],
  "hasNext": false
}

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/base/organizations/1/users?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/1/users', 'GET', body);