curl -X GET https://api.example.com/api/assessments/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN"
const assessmentId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
`https://api.example.com/api/assessments/${assessmentId}`,
{
headers: { 'Authorization': 'Bearer YOUR_TOKEN' }
}
);
const assessment = await response.json();
import requests
assessment_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
f'https://api.example.com/api/assessments/{assessment_id}',
headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
assessment = response.json()
{
"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"
}
{
"statusCode": 404,
"message": "Assessment not found",
"error": "Not Found"
}
{
"statusCode": 403,
"message": "Access denied",
"error": "Forbidden"
}
Assessments
Get assessment
GET
/
api
/
assessments
/
:id
curl -X GET https://api.example.com/api/assessments/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN"
const assessmentId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
`https://api.example.com/api/assessments/${assessmentId}`,
{
headers: { 'Authorization': 'Bearer YOUR_TOKEN' }
}
);
const assessment = await response.json();
import requests
assessment_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
f'https://api.example.com/api/assessments/{assessment_id}',
headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
assessment = response.json()
{
"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"
}
{
"statusCode": 404,
"message": "Assessment not found",
"error": "Not Found"
}
{
"statusCode": 403,
"message": "Access denied",
"error": "Forbidden"
}
Retrieve a single assessment by ID.
Path parameters
string
required
Assessment ID (UUID).
Response
string
Unique assessment identifier (UUID).
string
Assessment name.
string
Company name.
string
Company type.
string
Country of operation.
string
Current assessment status.Values:
DRAFT- Initial state, data collection in progressANALYZING- AI analysis in progressACTION_REQUIRED- Waiting for user input or gap resolutionCOMPLETE- Assessment and report complete
string
Data collection method.Values:
UPLOAD, GUIDED_INTERVIEW, MANUAL_ENTRYnumber
Completion percentage (0-100).
number
Version number for optimistic locking.
number
Aggregated risk score across all categories (0-100). Null until analysis is complete.
string
Overall risk classification. Null until analysis is complete.Values:
LOW, MODERATE, HIGH, CRITICALstring
ID of the user who created the assessment.
string
ISO 8601 timestamp of creation.
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"
const assessmentId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
`https://api.example.com/api/assessments/${assessmentId}`,
{
headers: { 'Authorization': 'Bearer YOUR_TOKEN' }
}
);
const assessment = await response.json();
import requests
assessment_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
f'https://api.example.com/api/assessments/{assessment_id}',
headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
assessment = response.json()
{
"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"
}
{
"statusCode": 404,
"message": "Assessment not found",
"error": "Not Found"
}
{
"statusCode": 403,
"message": "Access denied",
"error": "Forbidden"
}
⌘I