現在のアカウントが作成した Dream の履歴をページ単位で取得します。
GET /api/v1/forward/dreams
作成日時の新しい順に返されます。アーカイブ済みの Dream はデフォルトでは含まれません。
ヘッダー
| Header | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT or admin SAT>。 |
クエリパラメーター
| パラメーター | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
limit | integer | いいえ | 20 | 1 ページあたりの件数。範囲は 1-100。 |
after_id | string | いいえ | — | 現在のページの最後の Dream ID。より古いレコードの取得に使用します。 |
before_id | string | いいえ | — | 現在のページの最初の Dream ID。新しいレコードがある前のページに戻るために使用します。 |
include_archived | boolean | いいえ | false | アーカイブ済みの Dream を含めるかどうか。true または false のみ指定できます。 |
before_id と after_id は同時に使用できません。クエリパラメーターの重複や、未定義のパラメーターは許可されません。
リクエスト例
レスポンス例
HTTP 200 OK
空の一覧のレスポンス
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | object[] | 現在のページの Dream オブジェクト。 |
first_id | string/null | 現在のページの最初の Dream ID。空の一覧では null。 |
last_id | string/null | 現在のページの最後の Dream ID。空の一覧では null。 |
has_more | boolean | 現在のページング方向に続きのレコードが存在するかどうか。 |
エラー
| HTTP | Type | 発生条件 |
|---|---|---|
400 | invalid_request_error | ページング、真偽値、またはクエリパラメーターが無効です。error.code は invalid_pagination です。 |
401 | authentication_error | 認証情報がないか、無効または期限切れです。 |
403 | permission_error | トークンに Dream の参照権限がありません。この API は Identity SAT に対応していません。 |
404 | not_found_error | before_id または after_id が指す Dream が存在しないか、呼び出し元から参照できません。error.code は dream_not_found です。 |
500/502/503 | api_error | サービスまたは内部の依存サービスが一時的に利用できません。 |

