List broken link scans

GET

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

GET

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

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

{
  "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 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.

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. Repeat the parameter for several: any of them matches.

filter[status][]stringOptional

pending, done, failed or failed_partial. Repeat the parameter for several.

filter[type][]stringOptional

full or page. Repeat the parameter for several.

filter[method][]stringOptional

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]stringOptional

1 returns only the scans still running (status pending); 0 only the finished ones (done, failed or failed_partial).

sortstringOptional

created_at or updated_at; prefix with - for descending. Default: -created_at (newest first).

page[number]stringOptional

Page number, starting at 1. Default 1.

page[size]stringOptional

Items per page, 1 to 50. Default 15.

Response

200 - scans

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error