Garoon APIドキュメント

Garoon REST API

目次

スケジュール

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

API HTTPメソッド URL クラウド版 パッケージ版
1件の予定を取得する GET /api/v1/schedule/events/SCHEDULE_ID 〇 4.10以降
複数の予定を取得する GET /api/v1/schedule/events 〇 4.10以降
予定を登録する POST /api/v1/schedule/events 〇 4.10以降
予定を更新する PATCH /api/v1/schedule/events/SCHEDULE_ID 〇 4.10以降
予定を削除する DELETE /api/v1/schedule/events/SCHEDULE_ID 〇 4.10以降
空き予定を検索する POST /api/v1/schedule/searchAvailableTimes 〇 5.0以降
予定のカスタム項目（Schedule datastore）を取得する GET /api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_ID 〇 5.9以降
予定のカスタム項目（Schedule datastore）を登録する POST /api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_ID 〇 5.9以降
予定のカスタム項目（Schedule datastore）を更新する PUT /api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_ID 〇 5.9以降
予定のカスタム項目（Schedule datastore）を削除する DELETE /api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_ID 〇 5.9以降
施設の一覧を取得する GET /api/v1/schedule/facilities 〇 5.0以降
管理者権限で施設を取得する GET /api/v1/schedule/admin/facilities 〇 5.15以降
管理者権限で施設を登録する POST /api/v1/schedule/admin/facilities 〇 5.15以降
管理者権限で施設を更新する PATCH /api/v1/schedule/admin/facilities/FACILITY_ID 〇 5.15以降
管理者権限で施設を削除する DELETE /api/v1/schedule/admin/facilities/FACILITY_ID 〇 5.15以降
施設グループの一覧を取得する GET /api/v1/schedule/facilityGroups 〇 5.0以降
管理者権限で施設グループを取得する GET /api/v1/schedule/admin/facilityGroups 〇 5.15以降
管理者権限で施設グループを登録する POST /api/v1/schedule/admin/facilityGroups 〇 5.15以降
管理者権限で施設グループを更新する PATCH /api/v1/schedule/admin/facilityGroups/FACILITY_GROUP_ID 〇 5.15以降
管理者権限で施設グループを削除する DELETE /api/v1/schedule/admin/facilityGroups/FACILITY_GROUP_ID 〇 5.15以降
施設グループに所属する施設を取得する GET /api/v1/schedule/facilityGroups/{id}/facilities 〇 5.0以降

ワークフロー

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

API HTTPメソッド URL クラウド版 パッケージ版
申請データを取得する GET /api/v1/workflow/admin/requests 〇 5.0以降
申請データに添付されたファイルを取得する GET /api/v1/workflow/admin/files/FILE_ID 〇 5.0以降
申請フォームを構成している項目を取得する GET /api/v1/workflow/admin/forms/WORKFLOW_FORM_ID 〇 5.15以降

メッセージ

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

API HTTPメソッド URL クラウド版 パッケージ版
メッセージを取得する GET /api/v1/message/messages/MESSAGE_ID 〇
メッセージを作成する POST /api/v1/message/messages 〇
メッセージ一覧を取得する GET /api/v1/message/admin/messages 〇
メッセージの添付ファイルを取得する GET /api/v1/message/admin/messages/attached/FILE_Id 〇
メッセージの添付ファイル一覧を取得する GET /api/v1/message/admin/MESSAGE_ID/files 〇
メッセージの添付ファイルを削除する DELETE /api/v1/message/admin/messages/attached/FILE_ID 〇

スペース

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

API HTTPメソッド URL クラウド版 パッケージ版
スペースの一覧を取得する GET /api/v1/space/spaces 〇
ディスカッションを取得する GET /api/v1/space/SPACE_ID/discussions 〇
ディスカッションを作成する POST /api/v1/space/SPACE_ID/discussions 〇
コメントを作成する POST /api/v1/space/SPACE_ID/discussions/DISCUSSION_ID/comments 〇
スペースの添付ファイルを削除する DELETE /api/v1/space/admin/files/FILE_ID 〇
スペースの添付ファイルを取得する GET /api/v1/space/admin/files/FILE_ID 〇
ディスカッションの添付ファイル一覧を取得する GET /api/v1/space/admin/discussion/DISCUSSIONS_ID/files 〇
スペースの添付ファイル一覧を取得する GET /api/v1/space/admin/space/SPACE_ID/files 〇

ユーザー／組織

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

API HTTPメソッド URL クラウド版 パッケージ版
ユーザーの一覧を取得する GET /api/v1/base/users 〇 5.0以降
組織の一覧を取得する GET /api/v1/base/organizations 〇 5.0以降
組織に所属するユーザーの一覧を取得する GET /api/v1/base/organizations/ORGANIZATION_ID/users 〇 5.0以降

在席情報

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

API HTTPメソッド URL クラウド版 パッケージ版
在席情報を取得する（GaroonユーザーIDを指定） GET /api/v1/presence/users/USER_ID 〇 5.0以降
在席情報を取得する（ログイン名を指定） GET /api/v1/presence/users/code/LOGIN_NAME 〇 5.0以降
在席情報を更新する（GaroonユーザーIDを指定） PATCH /api/v1/presence/users/USER_ID 〇 5.0以降
在席情報を更新する（ログイン名を指定） PATCH /api/v1/presence/users/code/LOGIN_NAME 〇 5.0以降

ToDoリスト

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

API HTTPメソッド URL クラウド版 パッケージ版
ToDoを取得する GET /api/v1/todo/todos/TODO_ID 〇 6.0以降
ToDoを登録する POST /api/v1/todo/todos 〇 6.0以降
ToDoリストのカテゴリーを取得する GET /api/v1/todo/categories 〇 6.0以降

通知

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

API HTTPメソッド URL クラウド版 パッケージ版
通知を取得する GET /api/v1/notification/items 〇 5.0以降
通知を登録する POST /api/v1/notification/items 〇 5.0以降

プロキシAPI

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

API HTTPメソッド URL クラウド版 パッケージ版
プロキシAPI設定を取得する GET /api/v1/system/api/admin/proxies/code/PROXY_CODE 〇 5.15以降
プロキシAPI設定を登録する POST /api/v1/system/api/admin/proxies 〇 5.15以降
プロキシAPI設定を更新する PATCH /api/v1/system/api/admin/proxies/code/PROXY_CODE 〇 5.15以降
プロキシAPI設定を削除する DELETE /api/v1/system/api/admin/proxies/code/PROXY_CODE 〇 5.15以降

プラグイン

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

API HTTPメソッド URL クラウド版 パッケージ版
プラグインの基本設定を取得する GET /api/v1/system/plugin/admin/settings/PLUGIN_ID 〇 提供なし *1

*1 プラグインはクラウド版でのみ提供している機能です。 ^