> ## 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 rank schedules

> List authorized rank schedules.

`list_rank_schedules`

List authorized rank schedules. Active configuration does not prove hosted collection is enabled.

<Note>Development preview. This command is absent from the verified deployed bundle. Use a matching development environment.</Note>

| Access | Behavior |
| - | - |
| `discovery: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_rank_schedules",
      "arguments": {
        "limit": 50
      }
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call list_rank_schedules --args '{"limit":50}'
  ```

  ```bash HTTP theme={null}
  curl "$AGENTLINKOPS_API_URL/v1/commands/list_rank_schedules" \
    -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{"limit":50}'
  ```
</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": [
      {
        "id": "rank_example",
        "project_id": "pr_example",
        "collection_revision": 1,
        "config_version": 1,
        "provider": "dataforseo",
        "data_mode": "synthetic",
        "metric": "rank",
        "rank_scale": "one_thousand",
        "target": "example.com",
        "include_subdomains": true,
        "state": "paused",
        "anchor_at": "2026-09-30T00:00:00.000Z",
        "cadence_seconds": 604800,
        "stale_after_seconds": 1209600,
        "alerts": {
          "enabled": false,
          "direction": "either",
          "minimum_change": 10
        },
        "last_admitted_slot": null,
        "created_at": "2026-09-30T00:00:00.000Z",
        "updated_at": "2026-09-30T00:00:00.000Z",
        "availability": {
          "collection": "disabled",
          "alert_delivery": "not_enabled"
        }
      }
    ],
    "has_more": false,
    "next_cursor": null
  }
  ```
</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 | Optional | Identifier of the project returned by its create or list operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `cursor` | string | Optional | Opaque continuation returned by this same listing; omit for the first page. minLength: 1; maxLength: 1024 |
| `limit` | integer | Optional | Maximum rows in this page or bounded report; subject to the schema maximum. minimum: 1; maximum: 100; default: 50 |

### Validation and omitted values

Omitting projectId lists schedules across currently authorized projects in the credential workspace. Results sort by schedule ID; limit ranges from one to 100.

Use next\_cursor with the same project filter. Cursors bind to the current workspace, principal and grants. After INVALID\_CURSOR, restart the same listing without its cursor under current authority.

Read availability.collection and availability.alert\_delivery with state. An active saved configuration does not prove hosted collection or alert delivery is available.

Listing retained synthetic schedules makes no supplier request. Pages can change between calls and do not form a frozen customer export.

### Defaults when omitted

| Field | Default |
| - | - |
| `limit` | `50` |

## 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: 100
* **`has_more`** (boolean, required): True when another page is available.
* **`next_cursor`** (string / null, required): Opaque continuation for the same listing; null means no further page.

<Accordion title="All fields and nested objects">
  | Field | Type | Presence | Meaning and constraints |
  | - | - | - | - |
  | `items` | array | Required | Records in this bounded page. maxItems: 100 |
  | `items[].id` | string | Required | Resource identifier returned by the operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
  | `items[].project_id` | string | Required | Project that owns this record. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
  | `items[].collection_revision` | integer | Required | maximum: 9007199254740991; exclusiveMinimum: 0 |
  | `items[].config_version` | integer | Required | maximum: 9007199254740991; exclusiveMinimum: 0 |
  | `items[].provider` | string | Required | must equal "dataforseo" |
  | `items[].data_mode` | string | Required | must equal "synthetic" |
  | `items[].metric` | string | Required | must equal "rank" |
  | `items[].rank_scale` | string | Required | must equal "one\_thousand" |
  | `items[].target` | string | Required | minLength: 1; maxLength: 253 |
  | `items[].include_subdomains` | boolean | Required | |
  | `items[].state` | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: "active", "paused" |
  | `items[].anchor_at` | string | Required | format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]\|\d\d\[13579]\[26]\|\d\d0\[48]\|\[02468]\[048]00\|\[13579]\[26]00)-02-29\|\d\{4}-(?:(?:0\[13578]\|1\[02])-(?:0\[1-9]\|\[12]\d\|3\[01])\|(?:0\[469]\|11)-(?:0\[1-9]\|\[12]\d\|30)\|(?:02)-(?:0\[1-9]\|1\d\|2\[0-8])))T(?:(?:\[01]\d\|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$" |
  | `items[].cadence_seconds` | integer | Required | minimum: 86400; maximum: 2592000 |
  | `items[].stale_after_seconds` | integer | Required | minimum: 86400; maximum: 5184000 |
  | `items[].alerts` | object | Required | additional fields rejected |
  | `items[].alerts.enabled` | boolean | Required | |
  | `items[].alerts.direction` | string | Required | values: "increase", "decrease", "either" |
  | `items[].alerts.minimum_change` | integer | Required | minimum: 1; maximum: 1000 |
  | `items[].last_admitted_slot` | string / null | Required | |
  | `items[].created_at` | string | Required | UTC timestamp when the record was created. format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]\|\d\d\[13579]\[26]\|\d\d0\[48]\|\[02468]\[048]00\|\[13579]\[26]00)-02-29\|\d\{4}-(?:(?:0\[13578]\|1\[02])-(?:0\[1-9]\|\[12]\d\|3\[01])\|(?:0\[469]\|11)-(?:0\[1-9]\|\[12]\d\|30)\|(?:02)-(?:0\[1-9]\|1\d\|2\[0-8])))T(?:(?:\[01]\d\|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$" |
  | `items[].updated_at` | string | Required | UTC timestamp of the last record update. format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]\|\d\d\[13579]\[26]\|\d\d0\[48]\|\[02468]\[048]00\|\[13579]\[26]00)-02-29\|\d\{4}-(?:(?:0\[13578]\|1\[02])-(?:0\[1-9]\|\[12]\d\|3\[01])\|(?:0\[469]\|11)-(?:0\[1-9]\|\[12]\d\|30)\|(?:02)-(?:0\[1-9]\|1\d\|2\[0-8])))T(?:(?:\[01]\d\|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$" |
  | `items[].availability` | object | Required | additional fields rejected |
  | `items[].availability.collection` | string | Required | values: "disabled", "synthetic" |
  | `items[].availability.alert_delivery` | string | Required | must equal "not\_enabled" |
  | `has_more` | boolean | Required | True when another page is available. |
  | `next_cursor` | string / null | Required | Opaque continuation for the same listing; null means no further page. |
</Accordion>

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

## Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict.

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

This operation has no separate resource alias. Use its generic command route in a matching environment.

## Continue

[get\_rank\_schedule](/reference/commands/get_rank_schedule) · [list\_rank\_schedules](/reference/commands/list_rank_schedules)

Follow the [related workflow](/guides/monitor-changes), 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.