LINKME API

The profile.
The links.
The bigger picture.

Retrieve public Linkme profiles with grouped contact details, social links, and page metadata. Keep the structure that makes those connections useful.

Explore the endpoint API reference

Live private service

WHAT’S ON THE MAP

The data you need.
The details that matter.

View full coverage

Public profile details

Retrieve published names, bios, image paths, and available profile counts.

Links with their context

Preserve contact and social link groups, source order, and published destination values.

The page behind the profile

Read published theme settings and section visibility alongside profile data.

YOUR FIRST REQUEST

Get to the
good data.

Start with a local worker and a service key. The examples use the current Linkme contract.

GET/v1/linkme

Get a Linkme profile

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.

Request and response fields

QUICKSTART / LOCAL EXAMPLES

# Local worker · use your own service key
export BASE_URL="http://localhost:3009"

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

const baseUrl = "http://localhost:3009";
const url = new URL('/v1/linkme', baseUrl);
url.searchParams.set("url", "https://link.me/example");

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'x-api-key': process.env.LINKME_API_KEY
  }
});

const data = await response.json();
console.log(data);

GET/v1/linkmeJSON response

Examples target local workers. Use the origin and credentials supplied for your service.

TAKE IT SOMEWHERE USEFUL

Made for what
you’re making.

Enrich profile records

Bring public creator and business details into your existing database.

Organize social connections

Keep linked accounts and published contact groups together in discovery tools.

Build profile indexes

Index supported public profile fields for your own search and research workflows.

BEFORE YOU BUILD

A few useful
answers.

Read the full reference

What does the Linkme API return?

A nested profile object with supported public fields, grouped contact and web links, and published page settings. Source order and unknown values are preserved.

Does it follow the links or load private profiles?

No. Link destinations are returned as data. Private, locked, or age-gated profiles are rejected, and gated link records are omitted with partial coverage.

Can I connect to a hosted endpoint?

The reference includes the local worker origin, service-key header, and setup details.

Is this an official Linkme API?

No. ScrapeAtlas is independent and is not affiliated with Linkme. This endpoint retrieves supported publicly available data.

The profile.The links.The bigger picture.

The data you need.The details that matter.