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

グループを取得する

目次

グループを取得する

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

グループ情報を取得します。
一度に取得できるグループは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='