---
title: "Get a link"
method: GET
path: "/v1/projects/{project}/links/{smartLink}"
tags: ["Smart Links"]
---

# Get a link

`GET /v1/projects/{project}/links/{smartLink}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/links/{smartLink}`
- Auth: HTTP bearer

One link with its plan's name loaded. A link of another project is `404 RESOURCE_NOT_FOUND`.

### Three fields that are easy to misread

**`urls.bot` is null without a bot.** The deep link exists only while the project runs a bot that hands out start links; the web address and the embed page are always there.

**`code` never changes, `slug` may.** Share `urls.web` where the slug is fine to change later; print `urls.bot` or a QR of `urls.web` and rely on the code, which survives every rename because the slug's redirect runs through the portal, where the code takes over.

**`clicks.total` is one per visitor address per hour.** A creator reading their own page a dozen times adds one, and no analytics cookie is set on a stranger.

## Path parameters

- `project` string, uuid, required
- `smartLink` string, uuid, required

## Response `200`

The link with its three addresses.

- object
  - `data` SmartLinkResource, required: A Smart Link: a tracked address a creator hands out per channel (a video description, a bio, a flyer), with where it sends people, the three addresses to share and its lifetime clicks. Every member who signs in within the attribution window of clicking it is credited to the link.
    - `id` string, required: The link's id.
    - `project_id` string, required: The project the link belongs to; slugs are unique within a project, not across projects.
    - `name` string, required: A creator-facing label, never shown to visitors.
    - `slug` string, required: The address segment after `/go/`: 2 to 32 lowercase letters, digits and hyphens. Renaming it changes the web address; the code and the bot link stay.
    - `code` string, required: The stable seven-character code the bot link and the attribution cookie carry. Never changes, so a printed QR and a shared bot link keep working after a rename.
    - `destination` object, required: Where the link sends people.
      - `type` string, required: `portal` (the portal home), `plan` (the checkout of one plan) or `bot` (the project's bot, the portal home when no bot is connected).
      - `plan_id` string, nullable, required: The plan a `plan` destination opens; null otherwise.
      - `plan_name` string, nullable: That plan's name, present when the relation is loaded.
    - `urls` object: The addresses to share, each crediting this link.
      - `web` string, required: The `/go/` address on the portal host. Share it anywhere; a visitor is counted once per hour and remembered for the attribution window.
      - `bot` string, nullable, required: The project bot's deep link carrying `via_<code>`; null when the project runs no bot that hands out start links.
      - `embed` string, required: The plan-cards page to frame on the creator's own website, with the code in `via`; every card opens the portal in the top window through this link.
    - `state` 'expired' | 'live' | 'archived', required: `live` (counts and credits), `expired` (past `expires_at`: the address still lands on the portal home, nothing is counted) or `archived` (put out of use by the creator; the figures stay).
    - `expires_at` string, nullable, required: When the link stops counting, ISO 8601; null for never.
    - `archived_at` string, nullable, required: When the creator archived it, ISO 8601; null while in use.
    - `clicks` object, required: Lifetime clicks on the web address, one per visitor address per hour.
      - `total` integer, required: The count.
      - `last_at` string, nullable, required: When the address was last followed, ISO 8601; null when never.
    - `created_at` string, nullable, required: When the link was created, ISO 8601.
    - `updated_at` string, nullable, required: When it last changed, ISO 8601.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)