Skip to main content
GET
/
api
/
assessments
/
:id
curl -X GET https://api.example.com/api/assessments/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_TOKEN"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Q1 2026 Risk Assessment",
  "companyName": "Acme Coffee Cooperative",
  "companyType": "Cooperative",
  "country": "Kenya",
  "status": "ANALYZING",
  "intakeMode": "UPLOAD",
  "progress": 35,
  "version": 3,
  "overallRiskScore": null,
  "overallRiskLevel": null,
  "userId": "auth0|123456789",
  "createdAt": "2026-03-04T10:30:00.000Z",
  "updatedAt": "2026-03-04T11:15:00.000Z"
}
Retrieve a single assessment by ID.

Path parameters

id
string
required
Assessment ID (UUID).

Response

id
string
Unique assessment identifier (UUID).
name
string
Assessment name.
companyName
string
Company name.
companyType
string
Company type.
country
string
Country of operation.
status
string
Current assessment status.Values:
  • DRAFT - Initial state, data collection in progress
  • ANALYZING - AI analysis in progress
  • ACTION_REQUIRED - Waiting for user input or gap resolution
  • COMPLETE - Assessment and report complete
intakeMode
string
Data collection method.Values: UPLOAD, GUIDED_INTERVIEW, MANUAL_ENTRY
progress
number
Completion percentage (0-100).
version
number
Version number for optimistic locking.
overallRiskScore
number
Aggregated risk score across all categories (0-100). Null until analysis is complete.
overallRiskLevel
string
Overall risk classification. Null until analysis is complete.Values: LOW, MODERATE, HIGH, CRITICAL
userId
string
ID of the user who created the assessment.
createdAt
string
ISO 8601 timestamp of creation.
updatedAt
string
ISO 8601 timestamp of last update.
curl -X GET https://api.example.com/api/assessments/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_TOKEN"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Q1 2026 Risk Assessment",
  "companyName": "Acme Coffee Cooperative",
  "companyType": "Cooperative",
  "country": "Kenya",
  "status": "ANALYZING",
  "intakeMode": "UPLOAD",
  "progress": 35,
  "version": 3,
  "overallRiskScore": null,
  "overallRiskLevel": null,
  "userId": "auth0|123456789",
  "createdAt": "2026-03-04T10:30:00.000Z",
  "updatedAt": "2026-03-04T11:15:00.000Z"
}

Build docs developers (and LLMs) love