FortWatchFortWatchDocs
Menu

List assessment reports

GEThttps://api.fortwatch.ai/app/assessments
Scope reports:readPagedOperation ID listAssessments

The workspace's assessment reports, newest first, with their status and share link.

Paged: send page and limit (100 by default, at most 500); the total is in X-Total-Count (paging).

Parameters

NameInTypeDescription
scopeTyperequiredquerystring | nullOne of: workspace, project, asset
scopeIdqueryinteger
limitquerystring
pagequerynumber

Example request

curl -X GET "https://api.fortwatch.ai/app/assessments?limit=100" \
  -H "Authorization: Bearer $FORTWATCH_API_KEY"

Response 200

The request succeeded.

FieldTypeDescription
reportsrequiredobject[]
idrequirednumber
workspaceIdrequirednumber
scopeTyperequiredstring
scopeIdrequirednumber | null
scopeNamerequiredstring
statusrequiredstring
errorrequiredstring | null
triggerrequiredstring
createdByUserIdrequirednumber | null
shareExpiresAtrequiredstring (date-time) | null
shareRevokedAtrequiredstring (date-time) | null
generatedAtrequiredstring (date-time) | null
createdAtrequiredstring (date-time)
updatedAtrequiredstring (date-time)
createdByUserobject
firstNamerequiredstring
lastNamerequiredstring
hasNarrativerequiredboolean
shareUrlrequiredobject | null
sharePdfUrlrequiredobject | null
shareLiverequiredboolean
dataobject | null
narrativeobject | null
json
{
  "reports": [
    {
      "id": 42,
      "workspaceId": 42,
      "scopeType": "string",
      "scopeId": 42,
      "scopeName": "string",
      "status": "string",
      "error": "string",
      "trigger": "string",
      "createdByUserId": 42,
      "shareExpiresAt": "2026-10-16T12:00:00.000Z",
      "shareRevokedAt": "2026-10-16T12:00:00.000Z",
      "generatedAt": "2026-10-16T12:00:00.000Z",
      "createdAt": "2026-10-16T12:00:00.000Z",
      "updatedAt": "2026-10-16T12:00:00.000Z",
      "createdByUser": {
        "firstName": null,
        "lastName": null
      },
      "hasNarrative": true,
      "shareUrl": {},
      "sharePdfUrl": {},
      "shareLive": true,
      "data": {},
      "narrative": {}
    }
  ]
}

Errors

400The request is not valid: a field is missing or has the wrong shape (the message names it).
401No valid credentials: the API key or access token is missing, revoked or expired (INVALID_API_KEY, INVALID_TOKEN).
403Not allowed: the key or token lacks this scope (SCOPE_REQUIRED), the route is dashboard-only (SESSION_REQUIRED), or a plan limit applies.
429Too many requests (RATE_LIMITED): wait the seconds Retry-After gives.