Browse the Linktree creator directory

Try in Playground

Discover public Linktree profiles by category or subcategory with display names, verification, avatars and pagination.

GET/v1/linktree/directoryx-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

categoryenumquery

Optional category selector. Defaults to all categories.

one of: all, business, creative, education, entertainment, fashion-beauty, food-beverage, government-politics, health-wellness, non-profit, other, tech, travel-tourism

Examplebusiness

subcategorystringquery

Optional subcategory ID from the returned subcategories list.

max 80 chars

pageintegerdefault: 1query

One-based page number; defaults to 1.

default: 1 · 1 – 100000

Example1

Response fields

Ordered directory records with username, URL, displayName, profilePictureUrl, isVerified, profileBadges and category id/label.

up to 100 items

profiles.usernamestring

Always included.

profiles.urlstring

Always included.

absolute HTTPS URL

profiles.displayNamestringnullable

Always included.

profiles.profilePictureUrlstringnullable

Always included.

profiles.isVerifiedbooleannullable

Always included.

profiles.profileBadgesstring[]nullable

Always included.

profiles.category.idstring

Always included.

profiles.category.labelstring

Always included.

Category choices as id and label.

up to 100 items

categories.idstring

Always included.

categories.labelstring

Always included.

Subcategory choices for the selected category, as id and label.

up to 100 items

subcategories.idstring

Always included.

subcategories.labelstring

Always included.

Optional category selector. Defaults to all categories.

category.idstring

Always included.

category.labelstring

Always included.

Optional subcategory ID from the returned subcategories list.

subcategory.idstring

Always included.

subcategory.labelstring

Always included.

pageinteger

One-based page number; defaults to 1.

≥ 0

totalPagesinteger

Source-reported number of pages for the selection.

≥ 0

hasNextPageboolean

Whether the source reports a following page.

nextPageintegernullable

Number of the next page.

requestIdstring

Identifier for correlating a request with operational logs.

Upstream request count, decoded public-page source bytes read, and total duration.

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.

complete applies to supported embedded public page fields. Inspect warnings for omitted or unavailable data.

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`	Linktree 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.

Code example

curl "https://api.scrapeatlas.com/v1/linktree/directory?category=business&page=1" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linktree/directory?category=business&page=1",
  {
    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/linktree/directory?category=business&page=1",
  {
    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(`Linktree request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/linktree/directory",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "category": "business",
        "page": 1
    },
    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/linktree/directory?category=business&page=1", 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/linktree/directory?category=business&page=1"))
            .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",
  "fetchedAt": "2026-09-18T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 24000,
    "durationMs": 350
  },
  "profiles": [
    {
      "username": "example",
      "url": "https://linktr.ee/example",
      "displayName": "Example Creator",
      "profilePictureUrl": "https://example.test/avatar.png",
      "isVerified": false,
      "profileBadges": null,
      "category": {
        "id": "business",
        "label": "Business"
      }
    }
  ],
  "categories": [
    {
      "id": "all",
      "label": "All Categories"
    },
    {
      "id": "business",
      "label": "Business"
    }
  ],
  "subcategories": [
    {
      "id": "startup",
      "label": "Startup"
    }
  ],
  "category": {
    "id": "business",
    "label": "Business"
  },
  "subcategory": null,
  "page": 1,
  "totalPages": 2,
  "hasNextPage": true,
  "nextPage": 2,
  "sourceUrl": "https://linktr.ee/discover/profile-directory/c/business/page-1/"
}

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