予定のリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/events/パラメータ
パスパラメータ
特になし
クエリパラメータ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| limit | integer | コレクションの最大件数（デフォルトは500） |
| query | string | 予定名・説明検索文字列 |
| user_id | integer | 予定を表示するユーザーのID（デフォルトは認可スタッフ） |
| show_partial_events | boolean | 繰り返し予定において、予定を1件ずつ取得するか Falseの場合は元となる予定のみを返す（デフォルトはtrue） |
| from_date | datetime | いつからの予定か（デフォルトは本日） |
| to_date | datetime | いつまでの予定か（デフォルトはfrom_date+1年） |
| type | string | タイプで絞り込み（normal） |
リクエストボディ
特になし
権限
スコープ
event.manageまたはevent
APIを利用できるユーザー
スタッフまたはアドミン
レスポンス
プロパティ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| items | list | リソースアイテムリスト ※詳細は「4.4 予定｜SPIRAL PLACE API」を参照 |
| limit | integer | リクエストされた上限数 |
| total_result_count | integer | 指定された範囲に含まれる全件数 |