4.5.7.1 トピックコメント:リスト|SPIRAL PLACE API

コメントのリストを返します。

リクエスト

HTTPリクエスト

GET https://api.spiral.place/v1/messages/[message_id]/comments/

パラメータ

パスパラメータ

パラメータ名データ型説明
message_idstringコメントを取得するトピックのID

クエリパラメータ

パラメータ名データ型説明
limitintegerコレクションの最大件数(デフォルトは500)
offsetintegerコレクションの表示開始インデックス(デフォルトは0)
sort_orderstring昇順か降順か
asc / desc(デフォルトはdesc)
show_deletedboolean削除済みのコメントを含めるか(デフォルトはtrue)

リクエストボディ

特になし


権限

スコープ

message.manageまたはmessage

APIを利用できるユーザー

該当トピックの閲覧権限のあるスタッフ


レスポンス

プロパティ

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