4.5.1 トピック:リスト|SPIRAL PLACE API

認可スタッフのトピックのリストを返します。

リクエスト

HTTPリクエスト

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

パラメータ

パスパラメータ

特になし

クエリパラメータ

パラメータ名データ型説明
limitintegerコレクションの最大件数(デフォルトは500)
offsetintegerコレクションの表示開始インデックス(デフォルトは0)
order_bystringコレクションの表示順
(id(昇順) / updated_datetime(降順))(デフォルトはupdated_datetime))
querystringタイトル・本文検索文字列
query_titlestringタイトルのみを検索
message_typestringトピックタイプでフィルタリング
(regular / event)
is_unconfirmedboolean認可スタッフの未確認トピックで絞り込み
is_staredboolean認可スタッフがスターをつけているトピックを絞り込み
labelinteger指定したラベルの設定されているトピックで絞り込み

リクエストボディ

特になし


権限

スコープ

message.manageまたはmessage

APIを利用できるユーザー

スタッフまたはアドミン


レスポンス

プロパティ

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