Linktree Page API

What is the Linktree Page API?

Paste a Linktree URL or username and get the public page as clean JSON. Canonical profile fields: platform, id (string), handle/username, url, displayName (name is a deprecated alias), description, avatar, verified. Also verticals[] (Linktree niche labels, e.g. music_artist), linkPlatforms[] (platforms Linktree detected on the page), timezone, and email when the creator publishes a mailto social. links[] are typed (CLASSIC, PRODUCT, SPOTIFY_*, YOUTUBE_VIDEO, GROUP, …) with id/url/thumbnail; PRODUCT rows resolve shopUrl when Linktree leaves url empty (url is always present — null only when no destination exists); GROUP children nest under links with parentId. socials[] is the icon list (incl. EMAIL_ADDRESS). socialAccounts{} is the camelCase HTTP map for catalog joins (instagram/tiktok/spotify/soundcloud/appleMusic/youtube/…) — email is not duplicated there (use top-level email). YouTube watch URLs in socialAccounts are resolved to the channel via oEmbed so they pipe into youtube/channel-details. Accepts cache / cacheMaxAge. Flat 1 credit. This is the fan-out point for a creator graph: one Linktree call feeds the rest of the catalog.

Fill in the parameters below and copy a ready-to-run request, or open the live Playground to run it against your account (no API key paste).

curl "https://api.captapi.com/v1/linktree/page?url=https%3A%2F%2Flinktr.ee%2Fmiguelangeles" \
  -H "Authorization: Bearer capt_live_..."
# or: -H "x-api-key: capt_live_..."

Example response

{
  "success": true,
  "data": {
    "platform": "linktree",
    "url": "https://linktr.ee/miguelangeles",
    "id": 15278008,
    "username": "miguelangeles",
    "name": "MIGUEL ANGELES",
    "description": "☆☆☆☆ IRL ANGEL ☆☆☆☆\nψ EMBRACE CHAOS ψ",
    "avatar": "https://ugc.production.linktr.ee/d3141538-f586-4f3f-bc9a-a82fbebab798_DEATHRATTLE-slowed-COVER.jpeg",
    "verified": false,
    "verticals": [
      "music",
      "creative"
    ],
    "linkPlatforms": [
      "TikTok",
      "Instagram"
    ],
    "timezone": "America/New_York",
    "email": "miguel@irlangel.com",
    "linkCount": 8,
    "links": [
      {
        "title": "new project \"BEFORE THE SUN RISES & WINTERR ENDS\"",
        "type": "SPOTIFY_ALBUM",
        "id": "463416775",
        "url": "https://open.spotify.com/album/0pgrg7phBbnwGJ2HBEl9EG?si=Zub7J4I3RySAaM9WVX3Okg",
        "thumbnail": "https://ugc.production.linktr.ee/8ed131c7-6d74-47fc-bceb-8be7f6bae4c8_ab67616d0000b2739bd93cc6e406b820dfff691f.jpeg"
      },
      {
        "title": "stream \"NOVEMBERR\"",
        "type": "SPOTIFY_SONG",
        "id": "460281204",
        "url": "https://open.spotify.com/track/62HnBMEdZjeFCd2T8g37T8?si=7bd35dd0e9f24d65",
        "thumbnail": "https://ugc.production.linktr.ee/3bd59146-cd44-4187-9601-4341b21070d2_ab67616d0000b2739ad10104c60fb9deff5b7f34.jpeg"
      }
    ],
    "socials": [
      {
        "type": "INSTAGRAM",
        "url": "https://instagram.com/miguelangeles"
      },
      {
        "type": "TIKTOK",
        "url": "https://tiktok.com/@irlangel"
      }
    ],
    "socialAccounts": {
      "instagram": "https://instagram.com/miguelangeles",
      "tiktok": "https://tiktok.com/@irlangel",
      "spotify": "https://open.spotify.com/artist/14xRX3JR8H4RWh8R7V3fvZ?si=EgRxWIPiRcaEHtSnqk5PAQ",
      "youtube": "https://www.youtube.com/watch?v=xiFUzOJaiC4",
      "soundcloud": "https://soundcloud.com/miguelangeles",
      "appleMusic": "https://music.apple.com/ca/artist/miguel-angeles/1209423162"
    }
  }
}

Billing metadata is returned in response headers: X-Captapi-Credits (credits charged), X-Captapi-Cache (hit or miss), and X-Captapi-Source. Failed requests (4xx/5xx) are never charged. See the full list of error codes in the error reference.

Response structure

A successful call returns success, cached, creditsUsed, and a data object with the following fields:

Parameters

Authentication: send your key as Authorization: Bearer capt_live_.... A typical call costs 1 credit. Pass cache=true for a free 24h cache hit; default is always fresh.

How it works

1. 1. Sign up — get 100 free credits, no card required.
2. 2. Create a key from your dashboard.
3. 3. Send one request to /v1/linktree/page and parse the JSON response.

Use cases

Frequently asked questions