Retrieve a scan

GET/v1/scans/{scan_id}

One scan run and its progress. Poll it while status is running.

Read-onlyAll plans

Path parameters

scan_idstringrequiredThe scan, scn_….

Response

A scan object (fields as in List scans).

Errors

401unauthorizedMissing or revoked API key.

404not_foundNo scan with that id that this key can read.

429rate_limitedToo many requests; see Retry-After.

Try it

your data · read-only

Checking your sign-in…

Request

curl "https://api.promptedbrand.com/v1/scans/scn_…" \
  -H "Authorization: Bearer $PB_API_KEY"

Response · 200

{
  "id": "scn_71bd…",
  "object": "scan",
  "brand_id": "brd_8f2kq1…",
  "kind": "daily",
  "status": "running",
  "engines": [
    "chatgpt",
    "perplexity"
  ],
  "answers_total": 50,
  "answers_done": 31,
  "started": "2026-10-14T04:00:03Z",
  "finished": null
}