Home SDK References

SDK References

Detailed platform SDK references for Android, iOS, React Native, Flutter, Web, and Node. Each article covers installation, initialization, runtime APIs, deferred claim behavior, event tracking, and troubleshooting patterns for production integrations.
By Tomas Radvansky •
6 articles

iOS SDK

Current SDK release: 0.2.16 (September 2026). LinkMe iOS SDK Deep linking, deferred deep linking, and attribution for iOS apps. CocoaPods License - Main Site - Setup Guide - SDK Reference - Help Center Quick start 1. Prerequisites - A LinkMe account with at least one app configured - iOS bundle ID and Apple Team ID added in the LinkMe portal - API keys (appId and appKey) from App Settings > API Keys 2. Install Swift Package Manager (recommended; iOS 14+; macOS 10.15+): 1. In Xcode: File > Add Packages... 2. Enter https://github.com/r-dev-limited/li-nk.me-ios-sdk 3. Select v0.2.16 or a later version tag and add LinkMeKit to your app target. The package manifest is at the repository root. CocoaPods (legacy): The v0.2.16 source release is available directly from Git while its CocoaPods trunk spec is being published: pod 'LinkMeKit', :git => 'https://github.com/r-dev-limited/li-nk.me-ios-sdk.git', :tag => 'v0.2.16' The current CocoaPods registry spec is pending publication; use SwiftPM or the Git tag above for the current fixes. 3. Configure Universal Links 1. In Xcode, enable Signing & Capabilities > Associated Domains and add: applinks:links.yourco.com 2. Add a custom URL scheme in Info.plist: <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>yourapp</string> </array> </dict> </array> LinkMe hosts the AASA file automatically once your domain is connected. 4. Initialize the SDK import SwiftUI import LinkMeKit @main struct MyApp: App { init() { LinkMe.shared.configure(config: .init( baseUrl: URL(string: "https://li-nk.me")!, appId: "your_app_id", appKey: "your_app_key", sendDeviceInfo: true, includeVendorId: true, includeAdvertisingId: false, debug: true )) } var body: some Scene { WindowGroup { ContentView() } } } 5. Handle links struct ContentView: View { @State private var message = "Waiting for link…" @State private var unsubscribe: (() -> Void)? private func display(_ payload: LinkPayload?) { guard let payload else { return } DispatchQueue.main.async { message = "Opened: \(payload.path ?? "/")" } } var body: some View { Text(message) .onOpenURL { LinkMe.shared.handle(url: $0) } .onContinueUserActivity(NSUserActivityTypeBrowsingWeb) { LinkMe.shared.handle(userActivity: $0) } .onAppear { unsubscribe?() unsubscribe = LinkMe.shared.addListener { display($0) } LinkMe.shared.getInitialLink { initial in if initial != nil { display(initial) } else { LinkMe.shared.claimDeferredIfAvailable { display($0) } } } } .onDisappear { unsubscribe?(); unsubscribe = nil } } } Deferred deep linking The SDK supports two strategies for first-install attribution: 1. Pasteboard (deterministic) — reads a cid token written by the LinkMe Edge interstitial before the App Store redirect. Enable Pasteboard for Deferred Links in App Settings. 2. Fingerprint (probabilistic fallback) — calls /api/deferred/claim when pasteboard is unavailable. Both are handled automatically by claimDeferredIfAvailable(). API reference Method Description configure(config:) Initialize the singleton handle(userActivity:) Forward NSUserActivity for Universal Links handle(url:) Forward custom scheme URLs getInitialLink(completion:) Get the payload that opened the app addListener(_:) Subscribe to link events (returns unsubscribe closure) claimDeferredIfAvailable(completion:) Claim deferred deep link on first install track(event:properties:) Send analytics events setUserId(_:) Associate a user ID; pass nil to clear it setAdvertisingConsent(_:) Toggle advertising identifier usage setReady() Signal readiness to process queued URLs Example app The ExampleApp/ directory contains a runnable SwiftUI sample. Update ExampleApp/Configuration/linkme.env with your keys and run on a device or simulator. License Apache-2.0 Call LinkMe.shared.setUserId(nil) on logout. SDK callbacks may arrive off the main thread; dispatch UI updates to the main queue, as above.

Last updated on Sep 08, 2026

Flutter SDK

Current SDK release: 0.3.4 (September 2026). LinkMe Flutter SDK Cross-platform deep linking, deferred deep linking, and attribution for Flutter apps. pub.dev License - Main Site - Setup Guide - SDK Reference - Help Center Quick start 1. Prerequisites - A LinkMe app configured with your iOS bundle ID and Android package name - API keys (appId and appKey) from App Settings > API Keys - Flutter 3.44+ (Swift Package Manager is enabled by default) 2. Install flutter pub add flutter_linkme_sdk Or add manually to pubspec.yaml: dependencies: flutter_linkme_sdk: ^0.3.4 3. Configure native platforms iOS — Set the Runner deployment target to iOS 14 or newer, then enable Associated Domains on the Runner target: applinks:links.yourco.com Add a custom URL scheme in Info.plist (CFBundleURLSchemes): yourapp Android — In android/app/src/main/AndroidManifest.xml, add intent filters: <!-- HTTPS App Links --> <intent-filter android:autoVerify="true"> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="https" android:host="links.yourco.com" /> </intent-filter> <!-- Custom scheme --> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="yourapp" /> </intent-filter> macOS — The plugin uses Swift Package Manager and registers Flutter's FlutterAppLifecycleDelegate hook. LinkMeKit 0.2.16 handles custom-scheme URLs on macOS through handleOpenURLs(_:); keep the generated Flutter SPM integration enabled for the macos target and configure the app's URL Types. 4. Initialize and handle links import 'dart:async'; import 'package:flutter/material.dart'; import 'package:flutter_linkme_sdk/flutter_linkme_sdk.dart'; Future<void> main() async { WidgetsFlutterBinding.ensureInitialized(); await LinkMe.shared.configure( const LinkMeConfig( appId: String.fromEnvironment('LINKME_APP_ID'), appKey: String.fromEnvironment('LINKME_APP_KEY'), ), ); // Cold-start link final initial = await LinkMe.shared.getInitialLink(); // Deferred deep link (first install) final deferred = initial == null ? await LinkMe.shared.claimDeferredIfAvailable() : null; runApp(App(initialPayload: initial, deferredPayload: deferred)); } class App extends StatefulWidget { const App({super.key, this.initialPayload, this.deferredPayload}); final LinkMePayload? initialPayload; final LinkMePayload? deferredPayload; @override State<App> createState() => _AppState(); } class _AppState extends State<App> { late final StreamSubscription<LinkMePayload> _sub; @override void initState() { super.initState(); WidgetsBinding.instance.addPostFrameCallback((_) { if (!mounted) return; final payload = widget.initialPayload ?? widget.deferredPayload; if (payload != null) routeUser(payload); }); // Live links while app is running _sub = LinkMe.shared.onLink.listen(routeUser); } @override void dispose() { _sub.cancel(); super.dispose(); } @override Widget build(BuildContext context) { return const MaterialApp(home: Placeholder()); } void routeUser(LinkMePayload payload) { // Navigate based on payload.path / payload.params } } Deferred deep linking Platform Primary Fallback iOS Pasteboard ( cid token) Fingerprint ( /api/deferred/claim ) Android Play Install Referrer ( /api/install-referrer ) Fingerprint ( /api/deferred/claim ) Enable Pasteboard for Deferred Links in App Settings for deterministic iOS attribution. Swift Package Manager Flutter discovers the plugin's Swift packages from ios/flutter_linkme_sdk/Package.swift and macos/flutter_linkme_sdk/Package.swift. Flutter 3.44+ generates the FlutterFramework package sibling automatically, and the plugin resolves LinkMeKit 0.2.16 from its repository-root Swift package. SwiftPM is the recommended integration for flutter_linkme_sdk 0.3.4. Projects that intentionally disable SwiftPM can use the plugin's CocoaPods integration once the LinkMeKit 0.2.16 spec is available on trunk. Until then, CocoaPods users can consume the iOS SDK 0.2.16 directly from its Git tag as documented in the iOS SDK README. Forced web redirects If a payload contains forceRedirectWeb: true and a non-empty webFallbackUrl, the SDK opens the external browser automatically and does not deliver that payload to getInitialLink(), claimDeferredIfAvailable(), or onLink. setUserId(null) clears identity on Web, React Native, Android 0.2.14, and LinkMeKit 0.2.16 through the Flutter bridges. Keep those native versions aligned when relying on Flutter native logout clearing. API reference Method Description configure(config) Initialize the SDK getInitialLink() Get the payload that launched the app onLink (Stream) Stream of payloads while the app is running claimDeferredIfAvailable() Claim deferred deep link on first install track(event, {properties}) Send analytics events setUserId(userId) Associate a user ID; pass null to clear it setAdvertisingConsent(granted) Toggle Ad ID inclusion setReady() Signal readiness to process queued links debugVisitUrl(url, {headers}) Debug helper for testing link resolution Config options Field Type Default Description appId String? — App identifier appKey String? — Optional read-only key sendDeviceInfo bool true Include device metadata includeVendorId bool true Include vendor identifier includeAdvertisingId bool false Include Ad ID (requires consent) debug bool false Enable verbose native logs Instance-based client final client = LinkMeClient(); await client.configure(const LinkMeConfig(appId: 'app_123')); Use LinkMeClient for dependency injection or test-friendly patterns. It mirrors the LinkMe API. Example app The example/ directory contains a runnable sample: cd example cp .env.example .env # fill in your keys flutter run Flutter 3.44's SwiftPM generator derives a local package identity from the parent directory name. Because this checkout is nested under sdks/flutter, the repository integration command stages a package-name consumer before building iOS/macOS: cd ../.. IOS_DEVICE="iPhone 17 Pro" npm run test:flutter Published applications use flutter_linkme_sdk from pub.dev and do not need this staging step. Troubleshooting - See the Android Troubleshooting guide for App Links verification issues. - Enable debug: true in LinkMeConfig to see native logs for link resolution and deferred claims. License Apache-2.0

Last updated on Sep 08, 2026

Android SDK

Current SDK release: 0.2.14 (September 2026). Android SDK reference Pair this with the Android setup tutorial. Below are the primary methods exposed by LinkMe.shared. Installation Add maven { url = uri("https://jitpack.io") } to dependencyResolutionManagement.repositories in settings.gradle.kts. Gradle dependency: implementation("com.github.r-dev-limited:li-nk.me-android-sdk:0.2.14"). See the setup tutorial for the full configuration. Payload shape LinkMePayload mirrors the iOS structure: Field Type Description linkId String? Unique link identifier. path String? Deep-link path defined on the link. params Map<String, String>? Query parameters merged from the click. utm Map<String, String>? UTM data. custom Map<String, String>? Custom metadata saved with the link. url String? Original universal link URL, when available. isLinkMe Boolean? true for LinkMe-resolved links, false for basic universal link fallbacks. Core API LinkMe.shared.configure(context, config) Initializes the SDK. Call once, typically in Application.onCreate. Config field Type Description appId String? App identifier from the portal. appKey String? Optional read-only key. sendDeviceInfo Boolean Default true . includeVendorId Boolean Default true . Sends Android ID. includeAdvertisingId Boolean Default false . Enable after consent. debug Boolean Default false . Enable verbose logging by setting debug = true (typically BuildConfig.DEBUG). When enabled, LinkMe prints install referrer, fingerprint, and network events to Logcat to help debug fingerprint mismatches. LinkMe.shared.handleIntent(intent) / onNewIntent(intent) Feed intents from Activity.onCreate and Activity.onNewIntent so LinkMe can parse them. override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) LinkMe.shared.handleIntent(intent) } override fun onNewIntent(intent: Intent?) { super.onNewIntent(intent) LinkMe.shared.onNewIntent(intent) } LinkMe.shared.getInitialLink(callback) Asynchronously delivers the payload that opened the app via App Links or a custom scheme. LinkMe.shared.getInitialLink { payload -> payload?.let(::routeUser) } LinkMe.shared.setUserId(id) Associates a user identifier with future events. LinkMe.shared.addListener(callback) Subscribes to future payloads while the app stays alive. Returns an unsubscribe function. val unsubscribe = LinkMe.shared.addListener { payload -> routeUser(payload) } // Later unsubscribe() LinkMe.shared.claimDeferredIfAvailable(context, callback) Uses the Play Install Referrer (with fingerprint fallback) to tie first installs to prior clicks. LinkMe.shared.claimDeferredIfAvailable(applicationContext) { payload -> payload?.let(::routeUser) } LinkMe.shared.track(event, properties) Sends analytics events. LinkMe.shared.track("open") LinkMe.shared.track("purchase", mapOf("amount" to 9.99)) LinkMe.shared.setAdvertisingConsent(granted) Toggles whether the Advertising ID may be sent. Call after your own consent dialog: LinkMe.shared.setAdvertisingConsent(true) Intent helpers - Ensure your manifest includes an HTTPS App Link with android:autoVerify="true" and (optionally) a custom scheme. - LinkMe automatically writes the correct assetlinks.json once you configure your package name + SHA-256 in the portal.

Last updated on Sep 08, 2026

React Native SDK

Current SDK release: 0.2.15 (September 2026). React Native SDK reference Read the React Native setup tutorial first. This page lists the available functions from @li-nk.me/react-native-sdk. Package: @li-nk.me/react-native-sdk Imports import { configure, getInitialLink, handleUrl, onLink, claimDeferredIfAvailable, track, setUserId, setAdvertisingConsent, setReady, LinkMePayload, } from '@li-nk.me/react-native-sdk'; Payload shape Field Type Notes path string | undefined Deep-link path ( /screen/123 ). params Record<string, string> | undefined Query parameters. utm Record<string, string> | undefined Normalized UTM values. custom Record<string, string> | undefined Custom metadata saved with the link. linkId string | undefined Unique short link ID. url string | undefined Original universal link URL, when available. isLinkMe boolean | undefined true for LinkMe-resolved links, false for basic universal link fallbacks. cid string | undefined Click identifier used for resolution. Functions configure(options) Initializes the singleton. Returns a promise. Option Type Description appId string Required. appKey string Optional read-only key. sendDeviceInfo boolean Default true . Include device metadata. includeVendorId boolean iOS vendor identifier. includeAdvertisingId boolean Leave false until consent granted. debug boolean Default false . When true , the SDK logs pasteboard checks and deferred claim responses to Metro/Xcode/Logcat for troubleshooting. getInitialLink() Resolves with the payload that opened the app (if any). const initial = await getInitialLink(); if (initial?.path) router.replace(initial.path); handleUrl(url: string) Manually process a URL. Returns Promise<boolean> indicating whether a payload was resolved. claimDeferredIfAvailable() Returns a deferred payload for first installs. Android uses Play Install Referrer when the native LinkMeInstallReferrer.getInstallReferrer module is available, otherwise fingerprint fallback; iOS uses pasteboard (if expo-clipboard is installed) before falling back to fingerprint matching. onLink(callback) Subscribes to future payloads. Returns { remove: () => void }. const sub = onLink((payload) => payload?.path && router.replace(payload.path)); sub.remove(); track(event, properties?) Sends analytics events. await track('open'); await track('signup', { method: 'email' }); setUserId(userId) Associates a user identifier with future events. setAdvertisingConsent(granted) Toggles whether advertising identifiers are sent. setReady() Signals readiness to process queued URLs. Call after consent dialogs or other async setup. Optional class API import LinkMeClient from '@li-nk.me/react-native-sdk'; const client = new LinkMeClient(); await client.configure({ appId: 'app_123' }); const initial = await client.getInitialLink(); const sub = client.onLink(() => {}); sub.remove(); Use this form if you want multiple instances (e.g., tests or dependency injection). Session lifecycle Call setUserId(null) on logout to clear the previous identity. Remove each link subscription during teardown. Call dispose() when the SDK owner is destroyed; reconfigure before reuse.

Last updated on Sep 08, 2026

Web SDK

Current SDK release: 0.2.15 (September 2026). Web SDK reference After following the Web setup tutorial, use these exports in any SPA or SSR project. Package: @li-nk.me/web-sdk Installation npm install @li-nk.me/web-sdk Exports configure(options) Initializes the SDK. Call once on the client. Option Type Notes appId string Required. appKey string Optional read-only key if your Edge instance enforces auth. fetch FetchLike Provide a custom fetch implementation (e.g. for SSR). autoResolve boolean Defaults to true in browser. Automatically resolves the current URL on load. autoListen boolean Defaults to true in browser. Hooks into popstate / pushState to fire listeners. stripCid boolean Defaults to true . Strips cid query parameter from the URL after resolution. sendDeviceInfo boolean Defaults to true . Includes device metadata in resolution requests. resolveUniversalLinks boolean Defaults to true . Resolves same-origin URLs as universal links. debug boolean Defaults to false . When enabled, the SDK logs URL parsing and deferred-claim requests to the console. resolveFromUrl(url?: string) Resolves the provided URL (or window.location.href) and returns a LinkMePayload | null. handleLink(url: string) Resolves a specific URL without stripping the location. Returns LinkMePayload | null. onLink(callback) Registers a listener for future payloads (history navigation, pushState, manual triggers). Returns { remove: () => void }. claimDeferredIfAvailable() Attempts to match anonymous visitors to deferred payloads using device fingerprints. Returns LinkMePayload | null. track(event, properties?) Sends analytics events tied to the current visitor. setUserId(userId) Associates a user identifier with subsequent events. getLastPayload() Returns the most recently resolved LinkMePayload, or null. extractCidFromUrl(url: string) Extracts a cid parameter from a URL string. Returns string | null. Payload shape type LinkMePayload = { linkId?: string; path?: string; params?: Record<string, string>; utm?: Record<string, string>; custom?: Record<string, string>; url?: string; isLinkMe?: boolean; cid?: string; duplicate?: boolean; }; Advanced: class API For dependency injection or testing, use LinkMeController or LinkMeWebClient directly: import { LinkMeWebClient } from '@li-nk.me/web-sdk'; const client = new LinkMeWebClient(); await client.configure({ appId: 'app_123' }); const payload = await client.resolveFromUrl(); LinkMeWebClient extends LinkMeController and exposes the same methods as the top-level functions. You can also provide custom environment and httpClientFactory via LinkMeControllerDeps. Additional exports: BrowserEnvironment, LinkMeEnvironment (interface), LinkMeControllerDeps, LinkListener, FetchLike. Example import { configure, resolveFromUrl, onLink } from '@li-nk.me/web-sdk'; await configure({ appId: process.env.NEXT_PUBLIC_LINKME_APP_ID!, }); const initial = await resolveFromUrl(); if (initial?.path) { router.replace(initial.path); } const sub = onLink((payload) => { if (payload?.path) router.replace(payload.path); }); // Later sub.remove(); Session lifecycle Call setUserId(null) on logout to clear the previous identity. Remove each link subscription during teardown. Call dispose() when the SDK owner is destroyed; reconfigure before reuse.

Last updated on Sep 08, 2026

Node SDK

Current SDK release: 0.2.14 (September 2026). Node SDK reference Pair this with the Node.js setup tutorial. The SDK exposes a typed LinkMeClient for creating and managing links programmatically. Package: @li-nk.me/node-sdk Installation npm install @li-nk.me/node-sdk import LinkMeClient from '@li-nk.me/node-sdk'; CommonJS usage const LinkMeClient = require('@li-nk.me/node-sdk').default; Client options const linkme = new LinkMeClient({ apiKey: process.env.LINKME_SERVER_KEY, // Optional for read-only usage fetch: customFetchImplementation, // Optional custom transport }); Option Type Description apiKey string Server/API key with can_write scope for link management. fetch typeof fetch Provide your own fetch when running on Node versions without global fetch. Models The package re-exports its TypeScript models: - Link — the full link entity returned by the API. - CreateLinkInput — camelCase input for creating links. - UpdateLinkInput — snake_case partial update payload matching the API schema. - NodeSDKOptions — constructor options for LinkMeClient. Link interface Link { id: string; app_id: string; domain_id?: string | null; slug: string; deep_link_path?: string | null; deep_link_params?: string | null; ios_custom_url?: string | null; android_custom_url?: string | null; web_fallback_url?: string | null; allow_param_passthrough: 0 | 1; force_redirect_web: 0 | 1; og_title?: string | null; og_description?: string | null; og_image_url?: string | null; utm?: string | null; utm_override?: string | null; internal?: 0 | 1; enabled: 0 | 1; click_count: number; last_click_at?: string | null; created_at?: string; } CreateLinkInput type CreateLinkInput = { appId: string; slug?: string; deepLink?: string | null; redirects?: { ios?: string | null; android?: string | null; web?: string | null; forceWeb?: boolean; }; utm?: Partial<Record<UTMField, string>>; utmPresetId?: string; utmOverrides?: Partial<Record<UTMField, boolean>>; allowParamPassthrough?: boolean; displayInPortal?: boolean; customData?: Record<string, string | number | boolean | null | undefined>; og?: { title?: string; description?: string; imageUrl?: string }; }; Where UTMField is 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'utm_id' | 'utm_source_platform' | 'utm_creative_format' | 'utm_marketing_tactic' | 'tags'. UpdateLinkInput Uses snake_case field names and 0 | 1 for boolean flags, matching the API schema directly: type UpdateLinkInput = Partial<Pick<Link, 'deep_link_path' | 'ios_custom_url' | 'android_custom_url' | 'web_fallback_url' | 'allow_param_passthrough' | 'force_redirect_web' | 'og_title' | 'og_description' | 'og_image_url' | 'utm' | 'utm_override' | 'enabled' >>; Zod Schemas The SDK also exports Zod schemas and their inferred types for runtime validation: Schema Inferred type Description LinkSchema LinkParsed Core link entity. ExtendedLinkSchema ExtendedLinkParsed Link with computed fields ( hostname , idUrl , slugUrl , clicks , installs ). CreateLinkInputSchema CreateLinkInputParsed Validates createLink input. UpdateLinkInputSchema UpdateLinkInputParsed Validates updateLink payload. CreateLinkResponseSchema CreateLinkResponseParsed Shape returned by createLink . LinkMeWebhookEnvelopeSchema LinkMeWebhookEnvelopeParsed Webhook envelope structure. import { LinkSchema, CreateLinkInputSchema } from '@li-nk.me/node-sdk'; Webhook Helper Functions The SDK includes generic helper functions for webhook receivers: - parseLinkMeWebhookEnvelope(payload) — validates the webhook JSON envelope using LinkMeWebhookEnvelopeSchema. - verifyLinkMeWebhookSignature(rawBody, signatureHeader, secret) — verifies X-LinkMe-Signature using HMAC-SHA256. import { parseLinkMeWebhookEnvelope, verifyLinkMeWebhookSignature, } from '@li-nk.me/node-sdk'; const rawBody = req.rawBody.toString('utf8'); if (!verifyLinkMeWebhookSignature(rawBody, req.get('X-LinkMe-Signature'), process.env.LINKME_WEBHOOK_SIGNING_SECRET!)) { res.status(401).json({ ok: false, error: 'Invalid signature' }); return; } const envelope = parseLinkMeWebhookEnvelope(JSON.parse(rawBody)); // forward `envelope` to your own destination (queue, analytics provider, warehouse, etc.) Methods createLink(input: CreateLinkInput) Creates a new short link under an app. displayInPortal behavior: - false hides the link from /portal/app/<appId>/links (still works as a universal link). - true keeps it visible in the portal list. - In current Node SDK versions, if omitted, displayInPortal defaults to false. - For older SDK/API clients that omit this field, server compatibility keeps links visible. Returns: Promise<{ id: string; app_id: string; domain_id: string | null; slug: string; slugUrl: string }> await linkme.createLink({ appId: 'app_123', slug: 'spring', displayInPortal: true, redirects: { ios: 'https://apps.apple.com/...', android: 'https://play.google.com/...', web: 'https://example.com/spring', }, }); getLink(id: string) Fetches a single link by slug or ID. Returns: Promise<Link> listLinks(appId: string) Returns every link under the given app with computed extras. Returns: Promise<Array<Link & { hostname?: string | null; idUrl?: string; slugUrl?: string; clicks?: number; installs?: number }>> updateLink(id: string, updates: UpdateLinkInput) Applies a partial update using snake_case field names and 0 | 1 for boolean flags. Returns: Promise<Link> await linkme.updateLink('spring', { web_fallback_url: 'https://example.com/spring-2025', force_redirect_web: 1, }); deleteLink(id: string) Deletes a link. Use with caution—deletions are permanent. await linkme.deleteLink('spring'); HTTP behavior - LinkMeClient uses fetch under the hood. Use Node.js 22 or 24 for a maintained runtime; the package declares Node.js 18 as its minimum. - Requests are sent to /api/... on https://li-nk.me and automatically include Authorization: Bearer <apiKey> when provided. - Input/output payloads are validated with Zod before being returned, so runtime errors surface early when a shape is wrong. For lower-level access (custom routes beyond link management) call the REST endpoints directly using the REST Endpoints & OpenAPI reference as a guide.

Last updated on Sep 08, 2026