認可スタッフのトピックのリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/messages/
パラメータ
パスパラメータ
特になし
クエリパラメータ
パラメータ名 | データ型 | 説明 |
---|---|---|
limit | integer | コレクションの最大件数(デフォルトは500) |
offset | integer | コレクションの表示開始インデックス(デフォルトは0) |
order_by | string | コレクションの表示順 (id(昇順) / updated_datetime(降順))(デフォルトはupdated_datetime)) |
query | string | タイトル・本文検索文字列 |
query_title | string | タイトルのみを検索 |
message_type | string | トピックタイプでフィルタリング (regular / event) |
is_unconfirmed | boolean | 認可スタッフの未確認トピックで絞り込み |
is_stared | boolean | 認可スタッフがスターをつけているトピックを絞り込み |
label | integer | 指定したラベルの設定されているトピックで絞り込み |
リクエストボディ
特になし
権限
スコープ
message.manageまたはmessage
APIを利用できるユーザー
スタッフまたはアドミン
レスポンス
プロパティ
パラメータ名 | データ型 | 説明 |
---|---|---|
items | list | 「4.5 トピック|SPIRAL PLACE API」のプロパティを参照 |
limit | integer | リクエストされた上限数 |
offset | integer | リクエストされた開始インデックス |
total_result_count | integer | 全件数 |