> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/broken-links-scans/list-broken-link-scans/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 your token can reach. A scan takes from minutes to several hours and a launch never waits for it: poll this list and read `status` (`pending` while running; `done`, `failed` or `failed_partial` once it ends). `type` is `full` (every published content type) or `page` (only the pages named at launch). `error_code` and `error_message` are null unless the run failed, and `finished_at` is null while it is still running. The issues a scan found are not here: read them with "List broken link issues" and "List broken link pages". Your role must be allowed to read Broken Links Checker scans; without it the request answers 403. Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/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. Repeat the parameter for several: any of them matches. - `filter[status][]` (string, optional) — `pending`, `done`, `failed` or `failed_partial`. Repeat the parameter for several. - `filter[type][]` (string, optional) — `full` or `page`. Repeat the parameter for several. - `filter[method][]` (string, optional) — How the scan started: `manual`, `automatic` for a scheduled one, or `force_first` for the first automatic scan of a website. Repeat the parameter for several: any of them matches. - `filter[active]` (string, optional) — `1` returns only the scans still running (status `pending`); `0` only the finished ones (`done`, `failed` or `failed_partial`). - `sort` (string, optional) — `created_at` or `updated_at`; prefix with `-` for descending. Default: `-created_at` (newest first). - `page[number]` (string, optional) — Page number, starting at 1. Default 1. - `page[size]` (string, optional) — Items per page, 1 to 50. Default 15. ## Response ### 200 200 - scans - `data` (list of ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaDataItems, optional) - `jsonapi` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaJsonapi, optional) - `links` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaLinks, optional) - `meta` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaMeta, optional) ## Errors ### 422 Unprocessable Entity Error 422 - Invalid filter value - `errors` (list of ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaErrorsItems, optional) - `jsonapi` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaDataItems - `attributes` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaDataItemsAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaDataItemsLinks, optional) - `type` (string, optional) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaLinks - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaMeta - `current_page` (double, optional) - `from` (double, optional) - `last_page` (double, optional) - `links` (list of ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaMetaLinksItems, optional) - `path` (string, optional) - `per_page` (double, optional) - `to` (double, optional) - `total` (double, optional) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaErrorsItems - `detail` (string, optional) - `source` (ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaErrorsItemsSource, optional) - `status` (string, optional) - `title` (string, optional) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaDataItemsAttributes - `created_at` (datetime, optional) — When the scan was created. - `current_batch` (integer, optional) — Batch being processed; 0 until the plugin reports. - `error_code` (string, optional, nullable) — Failure code; null unless the scan failed. - `error_message` (string, optional, nullable) — Failure message; null unless the scan failed. - `finished_at` (datetime, optional, nullable) — When the scan ended; null while it runs. - `links_enumerated` (integer, optional) — Links found by discovery. - `links_planned` (integer, optional) — Links planned for checking, updated while the scan runs. - `method` (enum, optional) — How the scan started: `manual`, `automatic` for a scheduled one, or `force_first` for the first automatic scan of a website. - Allowed values: `manual`, `automatic`, `force_first` - `pages_enumerated` (integer, optional) — Pages found by discovery. - `pages_planned` (integer, optional) — Pages planned for checking, updated while the scan runs. - `parts_done` (integer, optional) — Crawl parts finished. - `parts_empty` (integer, optional) — Crawl parts that found nothing to check. - `parts_failed` (integer, optional) — Crawl parts that failed. - `parts_total` (integer, optional) — Crawl parts planned. - `site_id` (integer, optional) — Id of the website that was scanned. - `status` (enum, optional) — How the scan ended: pending while it runs, done, failed, or failed_partial when some content types finished and others failed. - Allowed values: `pending`, `done`, `failed`, `failed_partial` - `total_batches` (integer, optional) — Batches the scan is split in. - `type` (enum, optional) — Scope of the scan: full covers every published content type, page only the pages named when it was launched. - Allowed values: `full`, `page` - `updated_at` (string, optional) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaDataItemsLinks - `self` (string, optional) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaMetaLinksItems - `active` (boolean, optional) - `label` (string, optional) - `url` (string, optional, nullable) ### ApiPublicV1SiteBrokenLinkScansGetResponsesContentApplicationJsonSchemaErrorsItemsSource - `parameter` (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() ```