Social platforms

Get a Linktree profile · Linktree API

GET/linktree/users/{username}

$min $0.003

Returns a public Linktree profile by username with its links and social accounts. Returns `not_found` when the profile does not exist.

Add to Claude Read the docs

Using ChatGPT, Claude Code or another client? See the setup steps

Request

curl https://api.unifapi.com/linktree/users/{username} \
  -H "Authorization: Bearer $UNIFAPI_KEY"

Parameters

usernamepathrequired: Linktree username, as in linktr.ee/{username}.
: The parameter for this Linktree operation. Use the URL-visible slug or id described in the docs.

Overview

This operation is part of the Linktree API in the social platforms category. It uses the same Bearer token, request tracing, error model, and billing envelope as every UnifAPI endpoint, so agents can switch between platforms without custom per-vendor glue code.

Use it when a workflow needs Linktree public data alongside other social networks, but should still keep one API key, one account balance, and one predictable JSON contract.

Common agent workflows

Resolve a public Linktree identity into structured profile metadata for enrichment agents.
Refresh creator, company, or account snapshots without managing source-specific response shapes.
Give an AI agent a stable Linktree data source without building a per-platform integration.
Normalize Linktree responses into the same UnifAPI envelope used across the catalog.

Response shape

Unified envelope, platform-native fields

Lookup responses return one canonical object in `data` with stable identifiers, source URLs where available, and platform-specific metadata normalized into predictable JSON.
The operation has a 3 credits ($0.003) minimum charge, so `billing.records_charged` can be higher than the visible records returned.
A not-found or invalid-input condition uses the unified UnifAPI error shape, so callers do not need special handling for each source platform.

Response status codes

200400401402404429500502503

Billing

This operation charges 1 credit per billable record, with a 3 credits ($0.003) operation minimum. Public responses include billing metadata with credits charged, records charged, and remaining workspace balance. Incorrect Credit deductions caused by platform failures can be restored as billing corrections.

Errors and retries

Authentication, validation, rate-limit, not-found, and provider errors use the unified UnifAPI error format. Agents should log `request_id`, retry only retryable failures, and treat invalid API keys, disabled keys, and expired keys as the same public `unauthorized` error type.

Response fields

Fields in the data object

A successful Get a Linktree profile call returns one data object with these fields.

platformstring | null: Social platform for this profile. One of: linktree.
usernamestring | null: Canonical public username/handle without a leading @.
display_namestring | null: Public display title shown on the page.
biostring | null: Public bio/description text when the page provides one.
avatar_urlstring | null: Best available avatar image URL; null when only a blank placeholder is shown.
profile_urlstring | null: Canonical public profile URL on the owning platform.
is_verifiedboolean | null: Whether the platform marks the profile as verified.
linksobject[]: Primary page links; empty when not found.
socialsobject[]: Social/contact entries; empty when not found.

Related endpoints