FortWatchFortWatchDocs
Menu

Get an assessment report

GEThttps://api.fortwatch.ai/app/assessments/{id}
Scope reports:readOperation ID getAssessment

One report; include=data adds its snapshot and narrative.

Parameters

NameInTypeDescription
idrequiredpathinteger
includequerystring

Example request

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

Response 200

The request succeeded.

FieldTypeDescription
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
{
  "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": "string",
    "lastName": "string"
  },
  "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.
404Not found in your workspace.
429Too many requests (RATE_LIMITED): wait the seconds Retry-After gives.