Retrieve a paginated history of Dreams created by the current account.
GET /api/v1/forward/dreams
Results are ordered by creation time, newest first. Archived Dreams are excluded by default.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or admin SAT>. |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 20 | Number of items per page, from 1-100. |
after_id | string | No | — | ID of the last Dream on the current page, used to continue to older records. |
before_id | string | No | — | ID of the first Dream on the current page, used to return to the previous page of newer records. |
include_archived | boolean | No | false | Whether to include archived Dreams. Accepts only true or false. |
before_id and after_id cannot be used together. Duplicate or undefined query parameters are not accepted.
Example request
Example response
HTTP 200 OK
Empty list response
Response fields
| Field | Type | Description |
|---|---|---|
data | object[] | Dream objects on the current page. |
first_id | string/null | ID of the first Dream on the current page; null for an empty list. |
last_id | string/null | ID of the last Dream on the current page; null for an empty list. |
has_more | boolean | Whether more records exist in the current pagination direction. |
Errors
| HTTP | Type | Trigger |
|---|---|---|
400 | invalid_request_error | Invalid pagination, boolean, or query parameters. error.code is invalid_pagination. |
401 | authentication_error | Authentication is missing, invalid, or expired. |
403 | permission_error | The token cannot query Dreams. Identity SAT is not supported by this endpoint. |
404 | not_found_error | The Dream referenced by before_id or after_id does not exist or is not visible to the caller. error.code is dream_not_found. |
500/502/503 | api_error | The service or an internal dependency is temporarily unavailable. |

