Documentation · API

API · Results

Reading scored attempts and their review state.

Example
Purpose
Reconcile outcomes into the source system reliably.
Prerequisites
  • results.read scope
Architecture
Results are read by external_id, optionally narrowed by assessment.

Configuration

Review statepending | approved | rejected (example values)

Implementation steps

  1. 01Prefer webhook result.available over polling
  2. 02Fall back to a reconciliation sweep for missed events

Examples

Read

bash
GET /api/v1/results?external_id=WC-8291&assessment_id=asm_pro_cert_001

Testing procedure

  • Confirm the reconciliation sweep finds an event you deliberately dropped

Troubleshooting

Result present but no certificate

Review state is not approved; certificates are gated on approval.