> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # List broken link scans GET https://api.modulards.com/api/public/v1/site-broken-link-scans 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. Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-scans/list-broken-link-scans ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Query parameters - `filter[site][]` (string, optional) — Exact website ids (repeatable) - `filter[status][]` (string, optional) — pending | done | failed | failed_partial (repeatable) - `filter[type][]` (string, optional) — full | page (repeatable) - `filter[method][]` (string, optional) — manual | automatic | force_first (repeatable) - how the scan was triggered - `filter[active]` (string, optional) — 1|0 - 1 = still running (status pending), 0 = finished (done, failed or failed_partial) - `sort` (string, optional) — created_at, updated_at; prefix with - to invert. Default: -created_at (newest first) - `page[number]` (string, optional) - `page[size]` (string, optional) — Max 50 ## Response ### 200 200 - scans - `data` (list of object, optional) - `attributes` (object, optional) - `created_at` (string, optional) - `current_batch` (double, optional) - `error_code` (any, optional, nullable) - `error_message` (any, optional, nullable) - `finished_at` (string, optional, nullable) - `links_enumerated` (double, optional) - `links_planned` (double, optional) - `method` (string, optional) - `pages_enumerated` (double, optional) - `pages_planned` (double, optional) - `parts_done` (double, optional) - `parts_empty` (double, optional) - `parts_failed` (double, optional) - `parts_total` (double, optional) - `site_id` (double, optional) - `status` (string, optional) - `total_batches` (double, optional) - `type` (string, optional) - `updated_at` (string, optional) - `id` (string, optional) - `links` (object, optional) - `self` (string, optional) - `type` (string, optional) - `jsonapi` (object, optional) - `version` (string, optional) - `links` (object, optional) - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) - `meta` (object, optional) - `current_page` (double, optional) - `from` (double, optional) - `last_page` (double, optional) - `links` (list of object, optional) - `active` (boolean, optional) - `label` (string, optional) - `url` (string, optional, nullable) - `path` (string, optional) - `per_page` (double, optional) - `to` (double, optional) - `total` (double, optional) ## Errors ### 422 Unprocessable Entity Error 422 - Invalid filter value - `errors` (list of object, optional) - `detail` (string, optional) - `source` (object, optional) - `parameter` (string, optional) - `status` (string, optional) - `title` (string, optional) - `jsonapi` (object, optional) - `version` (string, optional) ## Examples **Response** ```json { "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": "« 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 »", "url": null } ], "path": "{{base_url}}/api/public/v1/site-broken-link-scans", "per_page": 15, "to": 2, "total": 2 } } ``` **SDK Code** ```python 200 - scans import requests url = "https://api.modulards.com/api/public/v1/site-broken-link-scans" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - scans const url = 'https://api.modulards.com/api/public/v1/site-broken-link-scans'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - scans package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/site-broken-link-scans" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - scans require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/site-broken-link-scans") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - scans import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/site-broken-link-scans") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - scans request('GET', 'https://api.modulards.com/api/public/v1/site-broken-link-scans', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - scans using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/site-broken-link-scans"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - scans import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-broken-link-scans")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```