> ## 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 competitor sets
> List approved competitor sets in one accessible project, including retired sets.
`list_competitor_sets`
List approved competitor sets in one accessible project, including retired sets.
Hosted MCP registration verified. These schemas describe the development contract; confirm supported inputs with tools/list. Generic CLI/HTTP calls require a matching development server. Configure LINKTRAIL\_API\_URL; production does not expose these command routes.
| Access | Behavior |
| ---------------- | ---------------- |
| `discovery:read` | Reads saved data |
Reading saved data does not start a verification job. Mutations can change saved records or access; the effects below apply.
## 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.
```json MCP theme={null}
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_competitor_sets",
"arguments": {
"projectId": "project_example"
}
}
}
```
```bash CLI theme={null}
linktrail call list_competitor_sets --args '{"projectId":"project_example"}'
```
```bash HTTP theme={null}
curl "$LINKTRAIL_API_URL/v1/commands/list_competitor_sets" \
-H "Authorization: Bearer $LINKTRAIL_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"projectId":"project_example"}'
```
## 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.
```json theme={null}
{
"items": [
{
"v": 1,
"id": "cs_example",
"revision": 1,
"workspace_id": "ws_example",
"project_id": "project_example",
"approved_by": "user_example",
"approved_at": "2026-09-13T12:00:00.000Z",
"members": [
{
"id": "cm_customer",
"role": "customer",
"scope": {
"target_kind": "domain",
"target": "example.com",
"include_subdomains": true
}
},
{
"id": "cm_competitor",
"role": "competitor",
"scope": {
"target_kind": "domain",
"target": "competitor.example.org",
"include_subdomains": true
}
}
],
"current_revision": 1,
"retired_at": null
}
],
"next_cursor": null,
"has_more": false
}
```
## 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 | Identifier of the project returned by its create or list operation. minLength: 1; maxLength: 200 |
| `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
Omit cursor for the first page. Keep continuation cursors opaque and use them only with the same listing and filters.
Pages are ordered by stored identifier ascending, not by observation freshness.
### 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.
| Field | Type | Presence | Meaning and constraints |
| -------------------------------------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `items` | array | Required | Records in this bounded page. |
| `items[].v` | number | Required | v recorded for this result. must equal 1 |
| `items[].id` | string | Required | Resource identifier returned by the operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `items[].revision` | integer | Required | revision recorded for this result. minimum: 1; maximum: 9007199254740991 |
| `items[].workspace_id` | string | Required | Workspace that owns this record. 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[].approved_by` | string | Required | approved by recorded for this result. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `items[].approved_at` | string | Required | approved at recorded for this result. 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[].members` | array | Required | members recorded for this result. minItems: 2; maxItems: 11 |
| `items[].members[].id` | string | Required | Resource identifier returned by the operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `items[].members[].role` | string | Required | role recorded for this result. values: "customer", "competitor" |
| `items[].members[].scope` | object | Required | scope recorded for this result. additional fields rejected |
| `items[].members[].scope.target_kind` | string | Required | target kind recorded for this result. values: "domain", "exact\_url" |
| `items[].members[].scope.target` | string | Required | target recorded for this result. minLength: 1; maxLength: 4096 |
| `items[].members[].scope.include_subdomains` | boolean | Required | include subdomains recorded for this result. |
| `items[].current_revision` | number | Required | current revision recorded for this result. |
| `items[].retired_at` | string / null | Required | retired at recorded for this result. |
| `next_cursor` | string / null | Required | Opaque continuation for the same listing; null means no further page. |
| `has_more` | boolean | Optional | True when another page is available. |
[Download input schema](/schemas/list_competitor_sets.input.json) · [Download output schema](/schemas/list_competitor_sets.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
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/competitor-sets` | 200 | Remaining read arguments go in query parameters. |
## Continue
[get\_competitor\_set](/reference/commands/get_competitor_set)
Follow the [related workflow](/guides/competitor-research), inspect [capability status](/capability-status), or return to the [command index](/reference/index).