Linktree API Capability

Get Directory Page

Fetch one page of Linktree's public profile directory using a primary category or secondary subcategory filter.

Capability ID linktree.directory.get

Cost 1 credit per request

Maximum runtime 30 seconds

# Get Directory Page

Fetch one page of Linktree's public profile directory using a primary category or secondary subcategory filter.

- Platform: [Linktree](https://docs.upscrape.com/docs/platforms/linktree)
- Capability ID: `linktree.directory.get`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "page": 1,
    "subcategory": "personal"
  },
  "capability": "linktree.directory.get"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category` | `string` | No | Primary directory category. Omit both filters for all profiles; mutually exclusive with subcategory. |
| `page` | `integer` | No | 1-indexed directory page number (default 1). |
| `subcategory` | `string` | No | Secondary directory filter discovered from Linktree's public taxonomy; mutually exclusive with category. |

### Example input

```json
{
  "page": 1,
  "subcategory": "personal"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "current_page": 1,
  "profiles": [
    {
      "avatar_url": "https://ugc.production.linktr.ee/KnXNMCTwSKag5nWQFsDM_66b5iwx3kpvar1wu",
      "category_id": "other",
      "category_name": "Other",
      "profile_url": "https://linktr.ee/pastellbunnii",
      "username": "pastellbunnii",
      "verified": false
    },
    {
      "category_id": "other",
      "category_name": "Other",
      "profile_url": "https://linktr.ee/mdk88",
      "username": "mdk88",
      "verified": false
    },
    {
      "avatar_url": "https://ugc.production.linktr.ee/yeq36Fz9SeeTOqZ2bW9y_p4AmDa6CfENB29um",
      "category_id": "other",
      "category_name": "Other",
      "profile_title": "Our story, Our recovery",
      "profile_url": "https://linktr.ee/missyandhemi",
      "username": "missyandhemi",
      "verified": false
    }
  ],
  "selected_category": "other",
  "selected_subcategory": "personal",
  "total_pages": 296
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `current_page` | `integer` | 1 |
| `profiles` | `array` | 3 items |
| `profiles` | `array` | 3 items |
| `selected_category` | `string` | other |
| `selected_subcategory` | `string` | personal |
| `total_pages` | `integer` | 296 |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

category string optional

Primary directory category. Omit both filters for all profiles; mutually exclusive with subcategory.

Available values allbusinesscreativeeducationentertainmentfashion-beautyfood-beveragegovernment-politicshealth-wellnessnon-profitothertechtravel-tourism

page integer optional

1-indexed directory page number (default 1).

Example 1

subcategory string optional

Secondary directory filter discovered from Linktree's public taxonomy; mutually exclusive with category.

Example personal

Available values affiliate-marketingagency-consultingalcoholautomobilesactoractivismattractionsbars-restaurantscampus-organizationscannabischefclimateclothing-accessoriescoffee-teacomedycommunity-organizationcontests-giveawayscosplaycountries-municipalitiescraftscrowdfundingdance-theatredessertsdesignerdigital-creatordisaster-reliefdiversity-inclusione-learningedutechelectronic-press-kitemergency-servicesfan-clubfilm-tvfinancial-servicesfintechfragrancesgaming-esportsgrocerieshair-carehardwarehealthcarehome-cookinghome-improvement-maintenancehotels-lodginghr-recruitinginfluencerjewelryjudiciarylaw-enforcementlegal-serviceslibrarylife-coachinglive-eventsmakeup-skincaremarketing-advertisingmemesmilitary-veteransmobile-appmodelmuseumsmusicnail-carenot-listednutritionperformance-artpersonalpetspolicypoliticians-campaignsportfoliopublic-figurepublic-relationspublic-servicesradio-podcastsreal-estaterecreationreligionsaasschools-universitiesshoesshopping-retailsocial-mediaspiritualitysportsstartuptalent-agencytalent-managementtattoos-piercingsteachertransportationventure-capitalvisual-artsweddingswildlifewriter

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`current_page`	`integer`	1
`profiles`	`array`	3 items
`profiles`	`array`	3 items
`selected_category`	`string`	other
`selected_subcategory`	`string`	personal
`total_pages`	`integer`	296

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "page": 1, "subcategory": "personal" }, "capability": "linktree.directory.get" }'

import json import requests payload = json.loads(r'''{ "input": { "page": 1, "subcategory": "personal" }, "capability": "linktree.directory.get" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "current_page": 1, "profiles": [ { "avatar_url": "https://ugc.production.linktr.ee/KnXNMCTwSKag5nWQFsDM_66b5iwx3kpvar1wu", "category_id": "other", "category_name": "Other", "profile_url": "https://linktr.ee/pastellbunnii", "username": "pastellbunnii", "verified": false }, { "category_id": "other", "category_name": "Other", "profile_url": "https://linktr.ee/mdk88", "username": "mdk88", "verified": false }, { "avatar_url": "https://ugc.production.linktr.ee/yeq36Fz9SeeTOqZ2bW9y_p4AmDa6CfENB29um", "category_id": "other", "category_name": "Other", "profile_title": "Our story, Our recovery", "profile_url": "https://linktr.ee/missyandhemi", "username": "missyandhemi", "verified": false } ], "selected_category": "other", "selected_subcategory": "personal", "total_pages": 296 }