> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List background website scans

> List retained background website scans for one project.

`list_internal_link_scans`

List retained background website scans for one project. Expired runs are unavailable.

<Note>This command name appears in deployment evidence dated 2026-10-16. This page describes current source; read your connected catalog for deployed inputs and access. Workspace scopes and enabled providers still apply.</Note>

| Access | Behavior |
| - | - |
| `watches:read` | Reads saved data |

This read does not start a verification job.

## Example request

Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "list_internal_link_scans",
      "arguments": {
        "projectId": "prj_example"
      }
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call list_internal_link_scans --args '{"projectId":"prj_example"}'
  ```

  ```bash HTTP theme={null}
  curl --fail-with-body https://app.agentlinkops.com/v1/commands/list_internal_link_scans \
    -H "Authorization: Bearer $AGENTLINKOPS_TOKEN" \
    -H 'Content-Type: application/json' \
    --data '{"projectId":"prj_example"}'
  ```
</CodeGroup>

## Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

<Accordion title="Full response example">
  ```json theme={null}
  {
    "items": [
      {
        "version": "internal-link-scan-v1",
        "id": "ilr_example",
        "projectId": "prj_example",
        "domain": "example.com",
        "homepage": "https://example.com/",
        "state": "queued",
        "reason": null,
        "createdAt": "2026-10-15T12:00:00.000Z",
        "updatedAt": "2026-10-15T12:00:00.000Z",
        "expiresAt": "2026-11-14T12:00:00.000Z",
        "completedAt": null,
        "revision": 0,
        "controlRevision": 0,
        "discoveredCount": 1,
        "completeCount": 0,
        "unknownCount": 0,
        "pendingCount": 1,
        "admittedCount": 0,
        "edgeCount": 0,
        "excludedReferences": 0,
        "exclusions": {},
        "nextEligibleAt": "2026-10-15T12:00:00.000Z",
        "discovery": {
          "state": "pending"
        },
        "coverage": {
          "inventory": "partial",
          "completeSiteCensus": false,
          "representation": "raw_html",
          "frontierTruncated": false,
          "renderedVisibility": false,
          "canonicalAliasesMerged": false
        },
        "usage": {
          "unit": "admitted_page",
          "period": "2026-10-15",
          "limit": 300,
          "used": 0,
          "resetsAt": "2026-10-16T00:00:00.000Z"
        }
      }
    ],
    "limits": {
      "pagesPerRun": 300,
      "workspacePagesPerDay": 300,
      "retainedRunsAndSnapshotsPerProject": 20,
      "retentionDays": 30,
      "pageBytes": 2097152,
      "pageTimeoutMs": 20000,
      "leaseMs": 90000,
      "maxAttempts": 3,
      "edgesPerPage": 200,
      "pageSize": 100
    }
  }
  ```
</Accordion>

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

| Field | Type | Presence | Meaning and constraints |
| - | - | - | - |
| `projectId` | string | Required | project ID from create/list. minLength: `1`; maxLength: `200` |

### Validation and omitted values

Returns up to 20 retained runs for one project; expired runs are excluded. Reads never enqueue capture.

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

* **`items`** (array, required): Records in this bounded page. maxItems: `20`
* **`limits`** (object, required): additional fields rejected

<Accordion title="All fields and nested objects">
  | Field | Type | Presence | Meaning and constraints |
  | - | - | - | - |
  | `items` | array | Required | Records in this bounded page. maxItems: `20` |
  | `items[].version` | string | Required | must equal `"internal-link-scan-v1"` |
  | `items[].id` | string | Required | Resource identifier returned by the operation. minLength: `1`; maxLength: `200` |
  | `items[].projectId` | string | Required | Identifier returned by the related operation. minLength: `1`; maxLength: `200` |
  | `items[].domain` | string | Required | |
  | `items[].homepage` | string | Required | |
  | `items[].state` | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: `"queued"`, `"running"`, `"paused"`, `"cancelled"`, `"complete"`, `"limit_reached"`, `"failed"` |
  | `items[].reason` | string / null | Required | Recorded explanation; null when no explanation applies. |
  | `items[].createdAt` | string | Required | |
  | `items[].updatedAt` | string | Required | |
  | `items[].expiresAt` | string | Required | |
  | `items[].completedAt` | string / null | Required | |
  | `items[].revision` | integer | Required | Optimistic concurrency revision; supply it as expectedRevision on the next write. minimum: `0`; maximum: `9007199254740991` |
  | `items[].controlRevision` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].discoveredCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].completeCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].unknownCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].pendingCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].admittedCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].edgeCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].excludedReferences` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].exclusions` | object | Required | |
  | `items[].nextEligibleAt` | string | Required | |
  | `items[].discovery` | object | Required | additional fields rejected |
  | `items[].discovery.state` | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: `"pending"`, `"complete"` |
  | `items[].discovery.coverage` | object | Optional | Dataset scope and completeness, including limits on what these results establish. additional fields rejected |
  | `items[].discovery.coverage.completeSiteCensus` | boolean | Required | must equal `false` |
  | `items[].discovery.coverage.truncated` | boolean | Required | |
  | `items[].discovery.coverage.reasons` | array | Required | |
  | `items[].discovery.documents` | array | Optional | maxItems: `13` |
  | `items[].discovery.documents[].requestedUrl` | string | Required | |
  | `items[].discovery.documents[].finalUrl` | string / null | Required | |
  | `items[].discovery.documents[].checkedAt` | string | Required | |
  | `items[].discovery.documents[].sha256` | string / null | Required | |
  | `items[].discovery.documents[].status` | integer / null | Required | Resource lifecycle status. |
  | `items[].discovery.documents[].reason` | string / null | Required | Recorded explanation; null when no explanation applies. |
  | `items[].discovery.documents[].kind` | string | Required | values: `"robots"`, `"index"`, `"urlset"`, `"unknown"` |
  | `items[].coverage` | object | Required | Dataset scope and completeness, including limits on what these results establish. additional fields rejected |
  | `items[].coverage.inventory` | string | Required | must equal `"partial"` |
  | `items[].coverage.completeSiteCensus` | boolean | Required | must equal `false` |
  | `items[].coverage.representation` | string | Required | must equal `"raw_html"` |
  | `items[].coverage.frontierTruncated` | boolean | Required | |
  | `items[].coverage.renderedVisibility` | boolean | Required | must equal `false` |
  | `items[].coverage.canonicalAliasesMerged` | boolean | Required | must equal `false` |
  | `items[].usage` | object | Required | additional fields rejected |
  | `items[].usage.unit` | string | Required | must equal `"admitted_page"` |
  | `items[].usage.period` | string | Required | |
  | `items[].usage.limit` | number | Required | must equal `300` |
  | `items[].usage.used` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `items[].usage.resetsAt` | string | Required | |
  | `limits` | object | Required | additional fields rejected |
  | `limits.pagesPerRun` | number | Required | must equal `300` |
  | `limits.workspacePagesPerDay` | number | Required | must equal `300` |
  | `limits.retainedRunsAndSnapshotsPerProject` | number | Required | must equal `20` |
  | `limits.retentionDays` | number | Required | must equal `30` |
  | `limits.pageBytes` | number | Required | must equal `2097152` |
  | `limits.pageTimeoutMs` | number | Required | must equal `20000` |
  | `limits.leaseMs` | number | Required | must equal `90000` |
  | `limits.maxAttempts` | number | Required | must equal `3` |
  | `limits.edgesPerPage` | number | Required | must equal `200` |
  | `limits.pageSize` | number | Required | must equal `100` |
</Accordion>

[Download input schema](/schemas/list_internal_link_scans.input.json) · [Download output schema](/schemas/list_internal_link_scans.output.json)

## Errors and retries

Follow the error recovery before retrying this read. Preserve the selected workspace, project, filters and feed. Recovering a read does not require an idempotency key or another verification job. Operation-specific errors include `INTERNAL_LINK_SCANS_UNAVAILABLE`, `INTERNAL_LINK_SCAN_EXPIRED`, `SCAN_CONTROL_CONFLICT`, `SCAN_FINISHED`, `SCAN_PAGE_LIMIT`, `INTERNAL_LINK_DAILY_LIMIT`, `INVALID_CURSOR`.

See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See [HTTP route details](/reference/http/routes).

| Method and route | Success | Details |
| - | - | - |
| `GET /v1/internal-links/scans` | 200 | Supply projectId in the query. Returns retained background scans without enqueueing work. |

## Continue

[get\_internal\_link\_scan](/reference/commands/get_internal_link_scan)

Follow the [related workflow](/guides/internal-links), inspect [capability status](/capability-status), or return to the [command index](/reference/index).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.