Link in bio API

Linktree

Live private service

Retrieve a public profile and its published links in one request.

Fetch profile details, links, grouped links, and social icons from the public Linktree page. No Linktree login is required.

Base URLhttp://localhost:3007

Local development example. Replace with your service origin.

Get a Linktree profile

GET/v1/linktree

Accepts one HTTPS linktr.ee profile URL. Tracking parameters and fragments are removed. Custom domains, duplicate parameters, and cache_max_age are unsupported.

Query parameters

Field	Type	Description
url	string	Required. A public HTTPS linktr.ee profile URL.

Request cURL

export BASE_URL="http://localhost:3007"
export API_KEY="your-service-key"

curl --get "$BASE_URL/v1/linktree" \
  -H "x-api-key: $API_KEY" \
  --data-urlencode "url=https://linktr.ee/example"

Response fields

Field	Type	Description
id	integer	Linktree's numeric account ID.
username	string	The username on the retrieved profile.
profilePictureUrl	string \| null	Profile image URL, or null when unavailable.
description	string \| null	Public bio, preserving line breaks; null when unavailable.
verticals	array \| null	Public category metadata; null when unavailable.
linkPlatforms	array \| null	Linktree's platform labels, which may differ from its social icons.
timezone	string \| null	Timezone exposed by Linktree, or null when unavailable.
links	array	Publicly embedded link records: id, type, title, url, and optional parentId. Includes action blocks. Empty URLs are preserved for groups and embedded blocks. Pins come first; duplicate IDs are returned once.
socialLinks	array	Published social icons as type and url, including types beyond the convenience fields below.
instagram	string	Published Instagram social icon; omitted if absent.
tiktok	string	Published TikTok social icon; omitted if absent.
spotify	string	Published Spotify social icon; omitted if absent.
youtube	string	Published YouTube social icon; omitted if absent.
soundcloud	string	Published SoundCloud social icon; omitted if absent.
apple_music	string	Published Apple Music social icon; omitted if absent.
email_address	string	Published email icon, with mailto: and query parameters removed; omitted if absent.
linkedin	string	Published LinkedIn social icon; omitted if absent.
discord	string	Published Discord social icon; omitted if absent.
requestId	string	Identifier for correlating a request with operational logs.
accounting	object	Upstream request count, decoded HTML bytes read, and total duration. Bytes exclude discarded error/redirect bodies and are not billing totals.
success	boolean	True when usable profile data is returned, including partial results.
status	string	success or partial. Failures return failed or challenged with a failure object.
sourceUrl	string	Final canonical profile URL after allowed redirects.
fetchedAt	string	UTC timestamp of retrieval.
coverage	object	complete applies to supported embedded public page fields. Inspect warnings for omitted or unavailable data.

Nested fields and every response variant are in the OpenAPI specification.

Response 200 · synthetic example

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "id": 123,
  "username": "example",
  "profilePictureUrl": "https://example.test/avatar.png",
  "description": "Synthetic creator",
  "verticals": [
    "music"
  ],
  "linkPlatforms": [
    "Instagram"
  ],
  "timezone": "America/New_York",
  "links": [
    {
      "id": 1,
      "type": "CLASSIC",
      "title": "Website",
      "url": "https://example.test/"
    },
    {
      "id": 2,
      "type": "PRODUCT",
      "title": "Merch",
      "url": ""
    }
  ],
  "socialLinks": [
    {
      "type": "INSTAGRAM",
      "url": "https://instagram.com/example"
    }
  ],
  "instagram": "https://instagram.com/example",
  "sourceUrl": "https://linktr.ee/example",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 18000,
    "durationMs": 350
  }
}

Coverage & limits

One profile per request; four concurrent requests per worker. Additional requests receive 503 busy.
15-second deadline; at most three upstream requests including redirects, with one retry for a network failure or HTTP 5xx.
Maximum 2 MiB decoded HTML; at most 500 visited links and ten nested group levels.
Locked profiles return restricted_page. Gated links and their descendants are omitted with a partial result.
Outbound links are returned as data. Destination pages, product catalogs, private analytics, follower counts, and media feeds are not fetched.
Fresh retrieval only. No cache, credits, billing, or public customer key management is implemented.
Some public link records reference groups omitted from the page. These links retain parentId and produce partial coverage with unresolved_parent.

Errors & partial results

HTTP	Code / status	Meaning
400	invalid_request	Invalid URL, missing URL, duplicates, or unsupported parameters.
401	unauthorized	Missing or invalid service API key.
403	restricted_page	The profile requires access or consent.
404	not_found	The profile is missing or inactive.
429	upstream_rate_limited	Linktree rate limited the request; no automatic retry.
502	upstream_challenged	The upstream rejected or challenged the request.
502	unsupported_page	Data is missing, malformed, or belongs to another profile.
502	response_too_large / unsafe_redirect / request_limit / upstream_error	Retrieval could not safely complete.
503	busy	All worker slots are in use.
504	timeout	The request exceeded its deadline.