Link in bio API

Linkme

Live private service

Retrieve a public Linkme profile with grouped contact links, social links, and page settings.

Read the profile embedded in Linkme’s public website. Preserve published IDs, grouped links, image paths, formatted visit counts, and theme metadata.

Base URLhttp://localhost:3009

Local development example. Replace with your service origin.

Get a Linkme profile

GET/v1/linkme

Accepts one public Linkme profile URL. The result is nested under profile, matching the reference API. Image paths and linkValue strings are returned as published; no destination is visited.

Query parameters

Field	Type	Description
url	string	Required. An HTTPS link.me/<username> URL. www, case, tracking parameters, and fragments are canonicalized.

Request cURL

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

curl --get "$BASE_URL/v1/linkme" \
  -H "x-api-key: $API_KEY" \
  --data-urlencode "url=https://link.me/example"

Response fields

Field	Type	Description
profile	object	The nested public profile object. Its grouped arrays and extra public attributes preserve their source order and values.
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	Coverage of the supported public embedded profile. Warnings identify omitted gated/malformed links, missing collections, or limits.

Profile fields

Field	Type	Description
id	string	Published website profile ID. It differs from the direct API’s numeric account ID.
username	string	Username from the public profile, checked against the requested URL.
isPrivate	number \| boolean	Only public profiles (0 or false) are returned.
firstName	string \| null	Published first name.
lastName	string \| null	Published last name; empty strings are preserved.
bio	string \| null	Published bio, preserving escapes and line breaks.
verifiedAccount	number \| boolean	Optional.
isAmbassador	number \| boolean	Optional.
friendStatus	number \| boolean	Optional.
profileVisitCount	string \| null	Upstream formatted count, such as 1.2k; not converted into an exact number.
isDefaultProfilePicture	boolean	Optional.
profileImage	string \| null	Published relative asset path; not converted into an absolute URL.
profileImageWebp	string \| null	Published relative WebP asset path.
referralLink	string \| null	Optional.
deeplink	string \| null	Optional.
logo	string \| null	Optional.
logoMetaData	string \| object \| null	Optional.
QRCode	string \| null	Optional.
webTheme	string \| null	Optional.
linkmeCustomIcon	string \| null	Optional.
cover	string \| null	Optional.
createdAt	string \| null	Optional.
updatedAt	string \| null	Optional.
stripeStatus	object \| null	Published tipping configuration only; no payments or account actions are performed.
killer	number \| boolean	Optional.
hideBottomButtons	number \| boolean	Optional.
customMailForm	number \| boolean	Optional.
hideAddToContacts	number \| boolean	Optional.
subscriptionFeature	string \| null	Optional.
showForm	boolean	Optional.
subscriptionType	number \| boolean	Optional.
displayNameOption	string \| null	Optional.
trackingPixels	array	Published configuration only. Tracking scripts are never executed.
isMuteEnable	number \| boolean	Optional.
totalLinks	number	Source-reported total. It may differ from the number of returned records and is not recomputed after omissions.
chatID	string \| null	Optional.
infoLinks	array	Ordered contact groups: title, linkId, isCustom, and links. Entries include webLinkId, linkValue, and optional display/image/adult flags.
businessInfo	object \| null	Public business metadata when present; null is preserved.
webLinks	array	Ordered web/social groups with the same grouping structure. Duplicate destinations are retained. Optional followerCount and image fields are preserved.
customisedTheme	object \| null	Published theme settings, including colors, background assets and font metadata.
totalFollowers	number \| string \| null	Published aggregate count; null stays null.
sectionSettings	object	Optional.
sectionVisibility	array	Published section ordering and visibility flags. A disabled section is not treated as an access gate.

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",
  "profile": {
    "id": "public-id-example",
    "username": "example",
    "isPrivate": 0,
    "firstName": "Example",
    "lastName": "Creator",
    "bio": "Synthetic profile",
    "profileImage": "user-profile/example/avatar.png",
    "profileVisitCount": "1.2k",
    "totalFollowers": null,
    "totalLinks": 2,
    "infoLinks": [
      {
        "title": "Email",
        "linkId": 1,
        "isCustom": false,
        "links": [
          {
            "webLinkId": 10,
            "linkValue": "hello@example.test",
            "isAdult": false
          }
        ]
      }
    ],
    "webLinks": [
      {
        "title": "Website",
        "linkId": 2,
        "isCustom": true,
        "links": [
          {
            "webLinkId": 20,
            "linkValue": "https://example.test/",
            "isAdult": false
          }
        ]
      }
    ],
    "customisedTheme": {
      "backgroundColor": "#FFFFFF"
    },
    "sectionVisibility": [
      {
        "section": "links",
        "order": 1,
        "enabled": 0
      }
    ]
  },
  "sourceUrl": "https://link.me/example",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 48000,
    "durationMs": 450
  }
}

Coverage & limits

One profile per request; four active requests per worker, with 503 busy on overload.
15-second total deadline; three upstream requests including redirects, with at most one retry for network errors or HTTP 5xx. No automatic 429/challenge retry.
2 MiB decoded HTML; 100,000 parser tokens; 4,096 shared references; nesting depth 24 and 10,000 expanded data nodes. Complex or unsupported serialization fails explicitly.
At most 500 visited link records across infoLinks and webLinks, with 100 groups per collection. Limits preserve the available records and report partial coverage.
Private, locked, or age-gated profiles return restricted_page. Gated link groups and entries are omitted with a partial result.
The parser reads serialized data only. It never executes page JavaScript, pixels, embedded markup, or outbound URLs.
The response covers the embedded profile object. Featured-link pagination, shouts, media feeds, products, courses, private analytics, and localized variants are not fetched.
Fresh page reads only; upstream page caching may still affect freshness. Custom domains, caching controls, billing, and customer key management are unsupported.

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	Linkme 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.
502	payload_too_complex	Embedded data exceeded token, reference, nesting, or expanded-node limits.
200	partial	Usable profile data with explicit warnings about missing, malformed, gated, or limited fields.