Get a Linkme profile

Try in Playground

Retrieve a public Linkme profile under profile, preserving image paths and linkValue strings.

GET/v1/linkmex-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

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

max 2048 chars · absolute HTTPS URL

Examplehttps://link.me/example

Response fields

The nested public profile object. Its grouped arrays and extra public attributes preserve their source order and values.

profile.idstring

Published website profile ID. It differs from the direct API’s numeric account ID.

min 1 chars

profile.usernamestring

Username from the public profile, checked against the requested URL.

min 1 chars

profile.isPrivatenumber | boolean

Only public profiles (0 or false) are returned.

profile.firstNamestringnullableoptional

Published first name.

profile.lastNamestringnullableoptional

Published last name; empty strings are preserved.

profile.biostringnullableoptional

Published bio, preserving escapes and line breaks.

profile.verifiedAccountnumber | booleanoptional

Optional.

profile.isAmbassadornumber | booleanoptional

Optional.

profile.friendStatusnumber | booleanoptional

Optional.

profile.profileVisitCountstringnullableoptional

Upstream formatted count, such as 1.2k; not converted into an exact number.

profile.isDefaultProfilePicturebooleanoptional

Optional.

profile.profileImagestringnullableoptional

Published relative asset path; not converted into an absolute URL.

profile.profileImageWebpstringnullableoptional

Published relative WebP asset path.

profile.referralLinkstringnullableoptional

Optional.

profile.deeplinkstringnullableoptional

Optional.

profile.logostringnullableoptional

Optional.

profile.logoMetaDatastring | objectnullableoptional

Optional.

profile.QRCodestringnullableoptional

Optional.

profile.webThemestringnullableoptional

Optional.

profile.linkmeCustomIconstringnullableoptional

Optional.

profile.coverstringnullableoptional

Optional.

profile.createdAtstringnullableoptional

Optional.

profile.updatedAtstringnullableoptional

Optional.

Published tipping configuration only; no payments or account actions are performed.

profile.stripeStatus.tipsEnablednumber | booleanoptional

Optional.

profile.stripeStatus.stripeAccountIdstringnullableoptional

Optional.

profile.stripeStatus.stripeEnabledbooleanoptional

Optional.

profile.killernumber | booleanoptional

Optional.

profile.hideBottomButtonsnumber | booleanoptional

Optional.

profile.customMailFormnumber | booleanoptional

Optional.

profile.hideAddToContactsnumber | booleanoptional

Optional.

profile.subscriptionFeaturestringnullableoptional

Optional.

profile.showFormbooleanoptional

Optional.

profile.subscriptionTypenumber | booleanoptional

Optional.

profile.displayNameOptionstringnullableoptional

Optional.

profile.trackingPixelsobject[]optional

Published configuration only. Tracking scripts are never executed.

profile.isMuteEnablenumber | booleanoptional

Optional.

profile.totalLinksnumberoptional

Source-reported total. It may differ from the number of returned records and is not recomputed after omissions.

≥ 0

profile.chatIDstringnullableoptional

Optional.

Ordered contact groups: title, linkId, isCustom, and links. Entries include webLinkId, linkValue, and optional display/image/adult flags.

up to 100 items

profile.infoLinks.titlestring

Always included.

profile.infoLinks.linkIdstring | number

Always included.

profile.infoLinks.isCustombooleanoptional

Optional.

Always included.

up to 500 items

profile.infoLinks.links.webLinkIdstring | number

Always included.

profile.infoLinks.links.linkValuestring

Always included.

profile.infoLinks.links.linkImagestringnullableoptional

Optional.

profile.infoLinks.links.faceValuestringnullableoptional

Optional.

profile.infoLinks.links.baseUrlstringnullableoptional

Optional.

profile.infoLinks.links.isCustombooleanoptional

Optional.

profile.infoLinks.links.isAdultbooleanoptional

Optional.

profile.infoLinks.links.followerCountnumbernullableoptional

Optional.

profile.infoLinks.links.profileImagestringnullableoptional

Optional.

profile.businessInfoobjectnullableoptional

Public business metadata when present; null is preserved.

Ordered web/social groups with the same grouping structure. Duplicate destinations are retained. Optional followerCount and image fields are preserved.

up to 100 items

profile.webLinks.titlestring

Always included.

profile.webLinks.linkIdstring | number

Always included.

profile.webLinks.isCustombooleanoptional

Optional.

Always included.

up to 500 items

profile.webLinks.links.webLinkIdstring | number

Always included.

profile.webLinks.links.linkValuestring

Always included.

profile.webLinks.links.linkImagestringnullableoptional

Optional.

profile.webLinks.links.faceValuestringnullableoptional

Optional.

profile.webLinks.links.baseUrlstringnullableoptional

Optional.

profile.webLinks.links.isCustombooleanoptional

Optional.

profile.webLinks.links.isAdultbooleanoptional

Optional.

profile.webLinks.links.followerCountnumbernullableoptional

Optional.

profile.webLinks.links.profileImagestringnullableoptional

Optional.

profile.customisedThemeobjectnullableoptional

Published theme settings, including colors, background assets and font metadata.

profile.totalFollowersnumber | stringnullableoptional

Published aggregate count; null stays null.

profile.sectionSettingsobjectoptional

Optional.

profile.sectionVisibilityobject[]optional

Published section ordering and visibility flags. A disabled section is not treated as an access gate.

requestIdstring

Identifier for correlating a request with operational logs.

Upstream request count, decoded HTML bytes read, and total duration. Bytes exclude discarded error/redirect bodies and are not billing totals.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable profile data is returned, including partial results.

statusenum

success or partial. Failures return failed or challenged with a failure object.

one of: success, partial

sourceUrlstring

Final canonical profile URL after allowed redirects.

absolute HTTPS URL

fetchedAtstring

UTC timestamp of retrieval.

Coverage of the supported public embedded profile. Warnings identify omitted gated/malformed links, missing collections, or limits.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	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.

Code example

curl "https://api.scrapeatlas.com/v1/linkme?url=https%3A%2F%2Flink.me%2Fexample" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linkme?url=https%3A%2F%2Flink.me%2Fexample",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

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

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linkme?url=https%3A%2F%2Flink.me%2Fexample",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Linkme request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/linkme",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://link.me/example"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/linkme?url=https%3A%2F%2Flink.me%2Fexample", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/linkme?url=https%3A%2F%2Flink.me%2Fexample"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "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
  }
}

Invalid URL, missing URL, duplicates, or unsupported parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}