Skip to main content
Files

List Files

Forward API reference.

Description

Lists Files visible to the current account, with pagination and filtering.

Path

GET /api/v1/forward/files

Request headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Query parameters

ParameterTypeRequiredDescription
identity_idstringNoUse 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.
limitintegerNoPage size, maximum 100.
pagestringNoPagination cursor (recommended), taken from next_page in the previous response. Mutually exclusive with after_id and before_id.
after_idstringNoForward pagination cursor. Mutually exclusive with page and before_id.
before_idstringNoBackward pagination cursor. Mutually exclusive with page and after_id.
namestringNoSearch by filename.
scope_idstringNoFilters 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

curl -X GET "https://api.qoder.com.cn/api/v1/forward/files" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

{
  "data": [
    {
      "id": "file_xxx",
      "type": "file",
      "filename": "report.pdf",
      "size_bytes": 1024,
      "mime_type": "application/pdf",
      "created_at": "2026-07-23T10:00:00Z",
      "updated_at": "2026-07-23T10:00:00Z",
      "downloadable": true,
      "scope": null,
      "metadata": {
        "source": "console"
      },
      "identity_id": null
    }
  ],
  "first_id": "file_xxx",
  "last_id": "file_xxx",
  "has_more": false,
  "next_page": null
}

Empty-list response

{
  "data": [],
  "first_id": null,
  "last_id": null,
  "has_more": false,
  "next_page": null
}

Response fields

Each item in the response data array is a File object. See List pagination fields for pagination fields.

Errors

HTTPTypeTrigger
400invalid_request_errorThe 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.
401authentication_errorThe authentication token is missing or invalid.
403permission_errorAn Owner mismatch occurs in administrator scope, or a downstream service denies access.
404not_found_errorThe Identity specified by the PAT does not exist, is disabled or deleted, or does not belong to the caller.
500/502/503api_errorForward or a dependent service failed.
Best Practices
API reference