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

グループを取得する

目次

グループを取得する

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

グループ情報を取得します。
1 度に取得できるグループは 100 件までです。

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

URL

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

https://sample.cybozu.com/v1/groups.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/groups.json?codes[0]=Recruit2022&codes[1]=Recruit2023

ヘッダー
1
2
3

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

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

レスポンス

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

プロパティ
プロパティ名 型 説明
groups 配列 グループ情報
形式は Group 型 を参照してください。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "groups": [
    {
      "id": "1",
      "code": "Recruit2022",
      "name": "2022年度採用プロジェクト",
      "description": "2022年採用プロジェクト"
    },
    {
      "id": "2",
      "code": "Recruit2023",
      "name": "2023年度採用プロジェクト",
      "description": "2023年度採用プロジェクト"
    }
  ]
}

サンプルコード

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

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

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