Documentation
Version
Platform Dashboard GuideREST API ReferenceMCP Server for AI AgentsBuilding ConnectorsWebhooks & EventsAutomations & Integrations
READ

list_links

List a project's Smart Links with their three addresses, state and lifetime clicks. Read-only. Paginated, optionally narrowed to archived links or searched by name or address.

Discover a project's Smart Links: the tracked addresses a creator hands out per channel (a video description, a bio, a flyer's QR). Use it to find a link's id before get_link, update_link or archive_link, or to list the addresses a creator asked for by name.

Read-only. Never mutates anything.

archived: false keeps expired links too: they are still the creator's and still carry their figures. Read state on each row, which is live, expired or archived.

Requires ability

project-link:view-any

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Runs the same action as

GET/v1/projects/{project}/links

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

project_id*string

UUID of the project whose links to list.

archivedbooleanoptional

Optional: true for archived links only, false for links still in use (expired ones included). Omit for every link.

searchstringoptional

Optional: keep links whose name or slug contains this text.

limitintegeroptional

Maximum links to return per page (1..100).

min1max100
pageintegeroptional

1-indexed page number.

min1
{  "data": [    {      "id": "7c2e5a90-3f41-4b8d-9e62-1a0d4c8b7f35",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "name": "YouTube description",      "slug": "youtube",      "code": "K7PMQ2X",      "destination": { "type": "plan", "plan_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80", "plan_name": "Premium" },      "urls": {        "web": "https://my.subscriby.net/jane/go/youtube",        "bot": "https://t.me/JaneBot?start=via_K7PMQ2X",        "embed": "https://my.subscriby.net/jane/embed/plans?via=K7PMQ2X"      },      "state": "live",      "expires_at": null,      "archived_at": null,      "clicks": { "total": 48, "last_at": "2026-11-21T09:58:12+00:00" },      "created_at": "2026-11-20T09:14:02+00:00",      "updated_at": "2026-11-21T10:02:40+00:00"    }  ],  "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}

urls.bot is null when the project runs no bot that hands out start links. code never changes; slug may, and urls.web moves with it.

VALIDATION_FAILED

limit outside 1..100 or page below 1.

RESOURCE_NOT_FOUND

unknown project_id, or the project is outside the token's scope.

AUTHENTICATION_REQUIRED

no authenticated user on the request.

TOKEN_MISSING_ABILITY

token lacks project-link:view-any.

Related

get_linkone link by id.get_link_funnelthe members and the revenue behind each link.create_linkmint a new one.Smart Links APIthe REST equivalent.Smart Linksthe feature walkthrough.

How is this guide?

Last updated on

get_link_funnel

Read the funnel behind a project's Smart Links, one link or all of them with the Direct row and totals that add up to the project's own figures. Read-only, lifetime by design.

update_link

Change a Smart Link's name, address, destination or expiry. Only the arguments present move; the code, the bot link and the attribution cookie survive every edit.