API reference

Get a scan

Poll a scan until its status is completed (or failed). Once complete, the summary carries the score and grade; fetch the full report separately.

GET/v1/scans/{id}

Path parameters

FieldTypeStatusDescription
idstringrequiredThe scan id returned by POST /v1/scans.

Response

FieldTypeDescription
idstringThe scan id.
statusstringqueued · running · completed · failed.
overall_scorenumber | null0–100, present once completed.
gradestring | nullA–F, present once completed.
pages_scannednumber | nullHow many pages were crawled.
started_at / completed_atstring | nullISO 8601 timestamps.
json
{
  "id": "scan_8fk2…",
  "status": "completed",
  "overall_score": 72,
  "grade": "C",
  "pages_scanned": 17,
  "started_at": "2026-06-10T15:01:22Z",
  "completed_at": "2026-06-10T15:03:05Z"
}

Examples

curl -s https://api.sifthealth.app/v1/scans/scan_8fk2 \
  -H "Authorization: Bearer $SIFT_API_KEY"