---
title: "Get a Linkme profile"
method: GET
path: "/v1/linkme"
tags: ["Linkme"]
---

# Get a Linkme profile

`GET /v1/linkme`

## Request

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

Retrieve a public Linkme profile under profile, preserving image paths and linkValue strings. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `url` string, uri, required: HTTPS link.me/<username> profile URL only. No credentials, ports or nested paths. www, case, tracking queries and fragments are canonicalized.

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `profile` object, required
      - `id` string, required
      - `username` string, required
      - `isPrivate` union, required
        - 0
        - false
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `bio` string, nullable
      - `verifiedAccount` union
        - number
        - boolean
      - `isAmbassador` union
        - number
        - boolean
      - `friendStatus` union
        - number
        - boolean
      - `profileVisitCount` string, nullable
      - `isDefaultProfilePicture` boolean
      - `profileImage` string, nullable
      - `profileImageWebp` string, nullable
      - `referralLink` string, nullable
      - `deeplink` string, nullable
      - `logo` string, nullable
      - `logoMetaData` union
        - string
        - object
      - `QRCode` string, nullable
      - `webTheme` string, nullable
      - `linkmeCustomIcon` string, nullable
      - `cover` string, nullable
      - `createdAt` string, nullable
      - `updatedAt` string, nullable
      - `stripeStatus` object, nullable
        - `tipsEnabled` union
          - number
          - boolean
        - `stripeAccountId` string, nullable
        - `stripeEnabled` boolean
      - `killer` union
        - number
        - boolean
      - `hideBottomButtons` union
        - number
        - boolean
      - `customMailForm` union
        - number
        - boolean
      - `hideAddToContacts` union
        - number
        - boolean
      - `subscriptionFeature` string, nullable
      - `showForm` boolean
      - `subscriptionType` union
        - number
        - boolean
      - `displayNameOption` string, nullable
      - `trackingPixels` object[]
      - `isMuteEnable` union
        - number
        - boolean
      - `totalLinks` number
      - `chatID` string, nullable
      - `infoLinks` object[]
        - `title` string, required
        - `linkId` union, required
          - string
          - number
        - `isCustom` boolean
        - `links` object[], required
          - `webLinkId` union, required
            - string
            - number
          - `linkValue` string, required
          - `linkImage` string, nullable
          - `faceValue` string, nullable
          - `baseUrl` string, nullable
          - `isCustom` boolean
          - `isAdult` boolean
          - `followerCount` number, nullable
          - `profileImage` string, nullable
      - `businessInfo` object, nullable
      - `webLinks` object[]
        - `title` string, required
        - `linkId` union, required
          - string
          - number
        - `isCustom` boolean
        - `links` object[], required
          - `webLinkId` union, required
            - string
            - number
          - `linkValue` string, required
          - `linkImage` string, nullable
          - `faceValue` string, nullable
          - `baseUrl` string, nullable
          - `isCustom` boolean
          - `isAdult` boolean
          - `followerCount` number, nullable
          - `profileImage` string, nullable
      - `customisedTheme` object, nullable
      - `totalFollowers` union
        - number
        - string
      - `sectionSettings` object
      - `sectionVisibility` object[]
    - `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' | 'payload_too_complex', 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)