コメントのリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/messages/[message_id]/comments/
パラメータ
パスパラメータ
パラメータ名 | データ型 | 説明 |
---|---|---|
message_id | string | コメントを取得するトピックのID |
クエリパラメータ
パラメータ名 | データ型 | 説明 |
---|---|---|
limit | integer | コレクションの最大件数(デフォルトは500) |
offset | integer | コレクションの表示開始インデックス(デフォルトは0) |
sort_order | string | 昇順か降順か asc / desc(デフォルトはdesc) |
show_deleted | boolean | 削除済みのコメントを含めるか(デフォルトはtrue) |
リクエストボディ
特になし
権限
スコープ
message.manageまたはmessage
APIを利用できるユーザー
該当トピックの閲覧権限のあるスタッフ
レスポンス
プロパティ
パラメータ名 | データ型 | 説明 |
---|---|---|
items | list | 「4.5.7 トピックコメント|SPIRAL PLACE API」のプロパティを参照 order_byはID固定 |
limit | integer | リクエストされた上限数 |
offset | integer | リクエストされた開始インデックス |
total_result_count | integer | 全件数 |