グループ

グループに関する情報を取得するには、次の API メソッドを使用します。

get_group

既存のグループを返します。

GET index.php?/api/v2/get_group/{group_id}

パラメーター

{
    "id": 1,
    "name": "New group",
    "user_ids": [1, 2, 3, 4, 5]
}

GET index.php?/api/v2/get_groups

レスポンスの内容

{
    "offset": 0,
    "limit": 250,
    "size": 0,
    "_links": {
        "next": null,
        "prev": null,
    },
    "groups": [
        {
            "id": 1,
            "name": "New group",
            "user_ids": [1, 2, 3, 4, 5]
        }
    ]
}

レスポンス コード

add_group

新しいグループを作成します。

POST index.php?/api/v2/add_group

{
    "name": "New Group",
    "user_ids": [1, 2, 3, 4, 5]
}

レスポンス コード

update_group

既存のグループを更新します。

POST index.php?/api/v2/update_group/{group_id}

パラメータ

エンドポイントは add_group と同じフィールドをサポートしています。

POST index.php?/api/v2/delete_group/{group_id}