Linktree — Profile & Links Management

Overview

Manages the complete lifecycle of a Linktree profile and its links through the Linktree REST API. This skill covers retrieving profile metadata, creating new links with positioning and thumbnails, updating existing link properties, listing all links for a profile, and reordering links by position. Use this workflow when building integrations that programmatically manage a creator's or brand's link-in-bio page — for example, syncing product launches, rotating seasonal promotions, or bulk-importing links from a spreadsheet. All operations use bearer token authentication against the Linktree API.

Prerequisites

• Linktree Developer Account — register at linktr.ee/marketplace/developer
• API Key — set

  LINKTREE_API_KEY

  in your environment
• Node.js >= 18 and TypeScript >= 5.0
• Linktree SDK — install with

  npm install @linktree/sdk

Instructions

Step 1: Get Profile

try {
  const profile = await client.profiles.get('myprofile');
  console.log(`Bio: ${profile.bio}`);
  console.log(`Links: ${profile.links.length}`);
} catch (err: any) {
  if (err.status === 404) throw new Error('Profile not found — verify the username');
  throw err;
}

Step 2: Create a Link

try {
  const link = await client.links.create({
    profile_id: profile.id,
    title: 'My Website',
    url: 'https://example.com',
    position: 0,  // Top of list
    thumbnail: 'https://example.com/icon.png'
  });
  console.log(`Created link: ${link.id}`);
} catch (err: any) {
  if (err.status === 422) throw new Error(`Validation failed: ${err.message}`);
  if (err.status === 429) console.warn('Rate limited — retry after backoff');
  throw err;
}

Step 3: Update Link

try {
  await client.links.update(link.id, {
    title: 'Updated Title',
    archived: false
  });
} catch (err: any) {
  if (err.status === 404) throw new Error(`Link ${link.id} not found — it may have been deleted`);
  throw err;
}

Step 4: List All Links

try {
  const links = await client.links.list({ profile_id: profile.id });
  links.forEach(l => console.log(`${l.position}: ${l.title} → ${l.url}`));
} catch (err: any) {
  if (err.status === 401) throw new Error('Invalid API key — check LINKTREE_API_KEY');
  throw err;
}

Error Handling

Unauthorized

LINKTREE_API_KEY

Not Found

Validation Error

Rate Limited

Server Error

Output

A successful workflow produces a fully configured Linktree profile with an ordered set of active links. Each link includes an

id

title

url

position

thumbnail

archived

links

Resources

• Linktree API Reference
• Linktree API Status Page
• Linktree Developer Blog

Next Steps

See

linktree-core-workflow-b