List broken link scans | Modular DS

{
  "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": "{{base_url}}/api/public/v1/site-broken-link-scans/5001"
      },
      "type": "site-broken-link-scans"
    },
    {
      "attributes": {
        "created_at": "2026-09-17T10:00:00.000000Z",
        "current_batch": 0,
        "error_code": null,
        "error_message": null,
        "finished_at": null,
        "links_enumerated": 0,
        "links_planned": 0,
        "method": "manual",
        "pages_enumerated": 0,
        "pages_planned": 2,
        "parts_done": 0,
        "parts_empty": 0,
        "parts_failed": 0,
        "parts_total": 0,
        "site_id": 12,
        "status": "pending",
        "total_batches": 1,
        "type": "page",
        "updated_at": "2026-09-17T10:00:00.000000Z"
      },
      "id": "5002",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-broken-link-scans/5002"
      },
      "type": "site-broken-link-scans"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-broken-link-scans?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-broken-link-scans?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/site-broken-link-scans?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-broken-link-scans",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Lists the Broken Links Checker runs of every website the token can reach, as a JSON:API collection of type site-broken-link-scans with the usual links / meta pagination.

Each entry carries status (pending, done, failed, failed_partial), type (full - every published content type; page - only the pages named at launch), method (manual, automatic, force_first), site_id, the crawl counters (parts_total, parts_done, parts_failed, parts_empty, pages_enumerated, links_enumerated, pages_planned, links_planned, total_batches, current_batch - 0 until the plugin reports), error_code / error_message (null unless the run failed), created_at, updated_at and finished_at (null while still running).

A scan takes from minutes to several hours: a launch never waits for it to finish - poll this listing and read status. The findings themselves are not here: they are “Broken Links Issues” › “List Broken Links issues” and “Broken Links Pages” › “List Broken Links pages”.

Websites of other organizations - and members without the read permission - answer 404; an unknown filter answers 400 and an invalid value 422. A read-only token is enough. The MCP twin of this endpoint is the site-broken-link-scans-index tool.

Lists the Broken Links Checker runs of every website the token can reach, as a JSON:API collection of type `site-broken-link-scans` with the usual `links` / `meta` pagination. Each entry carries `status` (`pending`, `done`, `failed`, `failed_partial`), `type` (`full` - every published content type; `page` - only the pages named at launch), `method` (`manual`, `automatic`, `force_first`), `site_id`, the crawl counters (`parts_total`, `parts_done`, `parts_failed`, `parts_empty`, `pages_enumerated`, `links_enumerated`, `pages_planned`, `links_planned`, `total_batches`, `current_batch` - `0` until the plugin reports), `error_code` / `error_message` (null unless the run failed), `created_at`, `updated_at` and `finished_at` (null while still running). A scan takes from minutes to several hours: a launch never waits for it to finish - poll this listing and read `status`. The findings themselves are not here: they are "Broken Links Issues" › "List Broken Links issues" and "Broken Links Pages" › "List Broken Links pages". Websites of other organizations - and members without the read permission - answer 404; an unknown filter answers 400 and an invalid value 422. A read-only token is enough. The MCP twin of this endpoint is the `site-broken-link-scans-index` tool.

Authentication

AuthorizationBearer

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

Query parameters

filter[site][]stringOptional

Exact website ids (repeatable)

filter[status][]stringOptional

pending | done | failed | failed_partial (repeatable)

filter[type][]stringOptional

full | page (repeatable)

filter[method][]stringOptional

manual | automatic | force_first (repeatable) - how the scan was triggered

filter[active]stringOptional

1|0 - 1 = still running (status pending), 0 = finished (done, failed or failed_partial)

sortstringOptional

created_at, updated_at; prefix with - to invert. Default: -created_at (newest first)

page[number]stringOptional

page[size]stringOptional

Max 50

Response

200 - scans

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error

Lists the Broken Links Checker runs of every website the token can reach, as a JSON:API collection of type site-broken-link-scans with the usual links / meta pagination.