List assessment reports
GEThttps://api.fortwatch.ai/app/assessments
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
| Name | In | Type | Description |
|---|---|---|---|
scopeTyperequired | query | string | null | One of: workspace, project, asset |
scopeId | query | integer | |
limit | query | string | |
page | query | number |
Example request
curl -X GET "https://api.fortwatch.ai/app/assessments?limit=100" \
-H "Authorization: Bearer $FORTWATCH_API_KEY"Response 200
The request succeeded.
| Field | Type | Description |
|---|---|---|
reportsrequired | object[] | |
idrequired | number | |
workspaceIdrequired | number | |
scopeTyperequired | string | |
scopeIdrequired | number | null | |
scopeNamerequired | string | |
statusrequired | string | |
errorrequired | string | null | |
triggerrequired | string | |
createdByUserIdrequired | number | null | |
shareExpiresAtrequired | string (date-time) | null | |
shareRevokedAtrequired | string (date-time) | null | |
generatedAtrequired | string (date-time) | null | |
createdAtrequired | string (date-time) | |
updatedAtrequired | string (date-time) | |
createdByUser | object | |
firstNamerequired | string | |
lastNamerequired | string | |
hasNarrativerequired | boolean | |
shareUrlrequired | object | null | |
sharePdfUrlrequired | object | null | |
shareLiverequired | boolean | |
data | object | null | |
narrative | object | null |
{
"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
400 | The request is not valid: a field is missing or has the wrong shape (the message names it). |
401 | No valid credentials: the API key or access token is missing, revoked or expired (INVALID_API_KEY, INVALID_TOKEN). |
403 | Not allowed: the key or token lacks this scope (SCOPE_REQUIRED), the route is dashboard-only (SESSION_REQUIRED), or a plan limit applies. |
429 | Too many requests (RATE_LIMITED): wait the seconds Retry-After gives. |
Every code is explained in Errors.