Link in bio API

Pillar

Live private service

Retrieve a public Pillar creator profile, social links, link click counts, and featured products.

Read the public shop data that powers a Pillar page. Get profile details, social accounts, ordered links, and product listings in one response.

Base URLhttp://localhost:3010

Local development example. Replace with your service origin.

Get a Pillar page

GET/v1/pillar

Accepts a public Pillar profile URL. Returns profile fields, links, and products at the top level, matching the reference API's data shape. Outbound URLs are returned as data and never visited.

Query parameters

Field	Type	Description
url	string	Required. An HTTPS pillar.io/<username> URL. www, case, tracking parameters, and fragments are canonicalized; nested paths and custom domains are unsupported.

Request cURL

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

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

Response fields

Field	Type	Description
id	string	Published creator UUID, checked against the requested public shop handle and record ownership.
first_name	string \| null	Structured account first name from Pillar’s public-client query. Upstream nulls are preserved; this is not inferred from a display name.
last_name	string \| null	Structured account last name from Pillar’s public-client query; upstream nulls are preserved.
email_primary	string \| null	Primary account email from Pillar’s public-client account query. This may differ from the displayed social email. Explicit upstream nulls are preserved; a failed or missing account response fails the request.
location	string \| null	Published location text; unknown or unavailable values are null.
email	string \| null	Public EMAIL social value. Other social channels appear as lowercase top-level keys, such as instagram, tiktok, youtube, github, and threads. Source empty strings and nulls are preserved.
links	array	Ordered public link records: id, type, title, url, clicks, and order. type and title are the trimmed, lowercase source tagline. Duplicates and source array order are preserved; no sorting by order is applied.
products	array	Featured product records: id, title, price, url, name, description, and image. title and name use the published product name. Prices keep source values; no currency conversion is performed. Descriptions may contain markup and are not executed.
requestId	string	Identifier for correlating the request with operational logs.
accounting	object	Upstream request count, decoded JSON bytes read, and duration. Rejected error bodies are discarded; these are operational counts, not billing totals.
success	boolean	True when usable data is returned, including partial results.
status	string	success or partial. Failures use failed or challenged and include a failure object.
sourceUrl	string	Canonical public profile URL.
fetchedAt	string	UTC timestamp of retrieval.
coverage	object	Coverage of supported public profile fields, links, and featured products. Warnings describe missing, malformed, gated, or limited data.

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

Response 200 · synthetic example

{
  "success": true,
  "status": "success",
  "id": "00000000-0000-4000-8000-000000000001",
  "first_name": "Example",
  "last_name": "Creator",
  "location": "Example City",
  "email": "hello@example.test",
  "email_primary": "account@example.test",
  "instagram": "https://instagram.com/example",
  "github": "",
  "links": [
    {
      "id": "00000000-0000-4000-8000-000000000010",
      "type": "my website",
      "title": "my website",
      "url": "https://example.test/",
      "clicks": 0,
      "order": null
    }
  ],
  "products": [
    {
      "id": "00000000-0000-4000-8000-000000000020",
      "title": "Example Product",
      "price": 19,
      "url": "https://example.test/product",
      "name": "Example Product",
      "description": "A synthetic product listing.",
      "image": null
    }
  ],
  "requestId": "00000000-0000-4000-8000-000000000099",
  "sourceUrl": "https://pillar.io/example",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 4,
    "responseBytes": 1300000,
    "durationMs": 1200
  }
}

Coverage & limits

One public profile per request; four concurrent requests per worker. Saturation returns 503 busy.
15-second total deadline and at most five upstream requests, including one shared retry for network errors or HTTP 5xx. Redirects are rejected; 429 and access challenges are not retried.
A cold request reads the public shop, page bootstrap, current client bundle, and account metadata. Subsequent requests normally need only shop and account reads. Tokens are sent only to Pillar’s fixed GraphQL endpoint, never to outbound URLs or other workers.
2 MiB total decoded bytes across shop JSON, client bootstrap, client source, and account response. Shop JSON is limited to nesting depth 16 and 20,000 nodes. Payload limits fail explicitly.
At most 500 visited links and products combined, processed in that order, and 100 social channels. Record limits produce partial coverage.
Private, password-protected, or consent-gated profiles are rejected. Gated records and related builder controls are omitted with a warning. Public presentation visibility flags are not access gates.
Missing collections return empty arrays with warnings. Missing metrics return null; they are never substituted with zero. Empty public collections do not add a missing-collection warning.
Coverage includes public profile fields, custom links, and featured products. Digital downloads, course lessons, bookings, membership content, funnels, videos, checkout, private analytics, and pagination are not fetched.
Fresh public API reads only. The ordinary logged-out frontend credential is discovered from Pillar’s current public client and retained only in memory for up to 15 minutes or its expiry. No account login, cookie jar, destination visits, result caching, billing, or customer key management. No production domain is assumed.
If the public client changes, expires, or does not expose the required account fields, retrieval fails explicitly. No primary-email substitution or reduced-field success is returned.

Errors & partial results

HTTP	Code / status	Meaning
400	invalid_request	Missing/invalid profile URL, duplicate URL, or unsupported parameters.
401	unauthorized	Missing or invalid service API key.
403	restricted_page	The profile requires access or consent.
404	not_found	The public profile is missing or inactive.
429	upstream_rate_limited	Pillar rate limited retrieval; no automatic retry.
502	upstream_challenged	Pillar rejected or challenged the public request.
502	unsupported_page	Malformed or unsupported JSON, missing identity, or mismatched profile.
502	response_too_large / payload_too_complex	The public JSON exceeds byte, depth, or node limits.
502	unsafe_redirect / request_limit / upstream_error	The bounded retrieval could not complete.
503	busy	All worker slots are in use.
504	timeout	Retrieval exceeded the total deadline.
502	public_client_unavailable / account_metadata_unavailable	The public client or required account metadata could not be verified.
200	partial	Usable data with warnings about missing, invalid, gated, or truncated records.