---
title: "Get a Linktree profile"
method: GET
path: "/v1/linktree"
tags: ["Linktree"]
---

# Get a Linktree profile

`GET /v1/linktree`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/linktree`
- Auth: API key in header `x-api-key`

Retrieve a public Linktree profile with display name, verification, badges, ordered links, block previews and social icons. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `url` string, uri, required: An HTTPS linktr.ee URL with a single profile path. No credentials or explicit ports. Query and fragment are stripped.

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `id` integer, required
    - `username` string, required
    - `displayName` string, nullable, required
    - `isVerified` boolean, nullable, required
    - `profileBadges` string[], nullable, required
    - `profilePictureUrl` string, nullable, required
    - `description` string, nullable, required
    - `verticals` string[], nullable, required
    - `linkPlatforms` string[], nullable, required
    - `timezone` string, nullable, required
    - `links` object[], required
      - `id` integer, required
      - `type` string, required
      - `title` string, required
      - `url` string, required
      - `parentId` integer
      - `details` object
        - `position` integer, nullable, required
        - `thumbnailUrl` string, nullable, required
        - `layout` string, nullable, required
        - `preview` object, nullable, required
          - `title` string, nullable, required
          - `description` string, nullable, required
          - `imageUrl` string, nullable, required
        - `embed` object, nullable, required
          - `option` string, nullable, required
          - `videoIds` string[], nullable, required
    - `socialLinks` object[], required
      - `type` string, required
      - `url` string, required
    - `instagram` string
    - `tiktok` string
    - `spotify` string
    - `youtube` string
    - `soundcloud` string
    - `apple_music` string
    - `email_address` string
    - `linkedin` string
    - `discord` string
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_page', required
      - `complete` boolean, required
      - `warnings` string[], required
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'restricted_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)