Forward API reference.
Description
Lists Files visible to the current account, with pagination and filtering.
Path
GET /api/v1/forward/files
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | No | Use only when operating on Identity-owned resources. A PAT can explicitly supply this query parameter; omitting it uses administrator scope. SAT ownership is determined by the credential. Explicitly supplying this parameter with any SAT (including an empty value) returns HTTP 400. See Identity ownership. |
limit | integer | No | Page size, maximum 100. |
page | string | No | Pagination cursor (recommended), taken from next_page in the previous response. Mutually exclusive with after_id and before_id. |
after_id | string | No | Forward pagination cursor. Mutually exclusive with page and before_id. |
before_id | string | No | Backward pagination cursor. Mutually exclusive with page and after_id. |
name | string | No | Search by filename. |
scope_id | string | No | Filters by resource scope ID, commonly used for Session resource files. Do not combine with before_id or after_id; cursors are ignored in this filter mode. |
Example request
Example response
Empty-list response
Response fields
Each item in the response data array is a File object. See List pagination fields for pagination fields.
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | The request body, path parameters, or query parameters are invalid; this includes explicitly supplying the query parameter identity_id with any SAT, even with an empty value. |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | An Owner mismatch occurs in administrator scope, or a downstream service denies access. |
| 404 | not_found_error | The Identity specified by the PAT does not exist, is disabled or deleted, or does not belong to the caller. |
| 500/502/503 | api_error | Forward or a dependent service failed. |

