認可スタッフの新着通知リストを返します。
同じインスタンスの最新の通知のみを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/notifications/
パラメータ
パスパラメータ
特になし
クエリパラメータ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| limit | integer | コレクションの最大件数(デフォルトは500) |
| offset | integer | コレクションの表示開始インデックス(デフォルトは0) |
| query | string | タイトル検索文字列 |
| is_unread | boolean | 未読のみフィルタリング(デフォルトはfalse) |
| show_past_count | boolean | 過去の通知件数を含めるか(デフォルトはfalse) |
| category | string | カテゴリーでフィルタリング(profile / message / event / task / user_file) |
| type | string | タイプでフィルタリング(normal / error) |
| target_id | integer | 対象インスタンスのID(target_idを指定する場合はcategory・typeが必須 |
リクエストボディ
特になし
権限
スコープ
notification
APIを利用できるユーザー
スタッフまたはアドミン
レスポンス
プロパティ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| items | list | 「4.8 新着通知|SPIRAL PLACE API」のプロパティ参照 |
| limit | integer | リクエストされた上限数 |
| offset | integer | リクエストされた開始インデックス |
| total_result_count | integer | 全件数 |
