Retrieve a broken link scan

GET

https://api.modulards.com/api/public/v1/site-broken-link-scans/:siteBrokenLinkScan

GET

/api/public/v1/site-broken-link-scans/:siteBrokenLinkScan

curl https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan \
     -H "Authorization: Bearer <token>"

200200 - scan

{
  "data": {
    "attributes": {
      "created_at": "2026-09-16T09:00:00.000000Z",
      "current_batch": 5,
      "error_code": null,
      "error_message": null,
      "finished_at": "2026-09-16T09:14:00.000000Z",
      "links_enumerated": 1830,
      "links_planned": 0,
      "method": "manual",
      "pages_enumerated": 240,
      "pages_planned": 0,
      "parts_done": 4,
      "parts_empty": 0,
      "parts_failed": 0,
      "parts_total": 4,
      "site_id": 12,
      "status": "done",
      "total_batches": 5,
      "type": "full",
      "updated_at": "2026-09-16T09:14:00.000000Z"
    },
    "id": "5001",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/site-broken-link-scans/5001"
    },
    "type": "site-broken-link-scans"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns one Broken Links Checker scan, with the same information as “List broken link scans”. Use the id that “Launch broken link scans” returned, or one from the list.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

siteBrokenLinkScanstringRequired

Response

200 - scan

dataobjectOptional

jsonapiobjectOptional