4.8.1 新着通知:リスト|SPIRAL PLACE API

認可スタッフの新着通知リストを返します。
同じインスタンスの最新の通知のみを返します。

リクエスト

HTTPリクエスト

GET https://api.spiral.place/v1/notifications/

パラメータ

パスパラメータ

特になし

クエリパラメータ

パラメータ名データ型説明
limitintegerコレクションの最大件数(デフォルトは500)
offsetintegerコレクションの表示開始インデックス(デフォルトは0)
querystringタイトル検索文字列
is_unreadboolean未読のみフィルタリング(デフォルトはfalse)
show_past_countboolean過去の通知件数を含めるか(デフォルトはfalse)
categorystringカテゴリーでフィルタリング(profile / message / event / task / user_file)
typestringタイプでフィルタリング(normal / error)
target_idinteger対象インスタンスのID(target_idを指定する場合はcategory・typeが必須

リクエストボディ

特になし


権限

スコープ

notification

APIを利用できるユーザー

スタッフまたはアドミン


レスポンス

プロパティ

パラメータ名データ型説明
itemslist4.8 新着通知|SPIRAL PLACE API」のプロパティ参照
limitintegerリクエストされた上限数
offsetintegerリクエストされた開始インデックス
total_result_countinteger全件数