Documentation

What's in here

linkboo's documentation is organized around what you're trying to do. The structure below maps to the most common starting points.

If you're new to the API, start with Quickstart. If you're integrating an existing system, go to Endpoint reference. If you're debugging a deep link or universal-link issue, the Technical guides are where the long-form material lives.

Quickstart (5 minutes)

The fastest path from "I have an API token" to "I have a working integration."

1. Get a token. Settings → API → Generate token. Pro accounts have read-only tokens by default; Agency accounts can issue read+write.
2. Make a test request. curl -H "Authorization: Bearer YOUR_TOKEN" https://api.link.boo/v1/pages returns your pages.
3. Create a link (Agency write tokens):

   curl -X POST https://api.link.boo/v1/links \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"destination":"https://example.com","label":"Test"}'
   

4. Tap the returned short_url from a mobile device with TikTok or Instagram installed — the escape flow runs automatically.
5. Read the analytics for the link via GET /v1/links/{id} after a few clicks.

Full quickstart with sample code →

Endpoint reference

The complete OpenAPI 3.1 specification, browsable in three formats:

• Interactive Swagger UI — try requests in your browser with your token.
• Static reference — searchable, deep-linkable, no JS required.
• OpenAPI JSON — for importing into Postman, Insomnia, or your own tooling.

Conceptual overview of the API is on the /api page.

SDKs

• JavaScript / TypeScript SDK — npm install @linkboo/sdk
• Python SDK — pip install linkboo
• Community SDKs — Ruby, Go, PHP

Each SDK reference includes installation, auth setup, the full method surface, error handling, and idiomatic examples.

Webhooks

The webhooks reference covers:

• Available event types and their payload shapes
• Signing and signature verification (HMAC-SHA256)
• Retry policy and delivery guarantees
• Replay protection
• Local development with the linkboo CLI tunnel
• Common patterns: building real-time dashboards, syncing audit events to a SIEM, building click-event ETL into BigQuery / Snowflake / Redshift

OAuth 2.0

If you're building a product that acts on behalf of linkboo users (an agency portal, a CMS integration, a third-party analytics dashboard), use OAuth 2.0 with PKCE rather than personal access tokens.

The OAuth docs cover:

• Registering an OAuth client
• The authorization code flow with PKCE
• Refresh token rotation
• Available scopes (mirror the API token scopes)
• Common client patterns (server-side web apps, native mobile apps, single-page apps)

Technical guides

The deep-link, universal-link, and escape-flow material — these are the long-form guides for engineers integrating or debugging.

• iOS universal links and the AASA file explained — what AASA actually does, common failure modes, how to validate.
• Android assetlinks.json explained — the verification flow, intent filters, common pitfalls.
• The in-app browser cookie problem — why webviews don't share cookies with Safari/Chrome and why the escape flow is the only reliable fix.
• Firebase Dynamic Links replacement — the migration writeup for teams moving off FDL.
• Branch.io alternatives — when Branch is the right call and when it isn't.
• Android in-app browser escape — how linkboo hands visitors off to Chrome so their real session comes with them.
• iOS in-app browser escape — how linkboo moves visitors into Safari so OAuth and cookies work correctly, including post-iOS-17 behavior.

CLI

The linkboo CLI is a thin wrapper around the API for shell scripting, CI usage, and local dev.

• Installation — Homebrew, npm, or single-binary download
• Commands — linkboo pages list, linkboo links create, linkboo audit tail, etc.
• Local webhook tunneling — receive webhooks on localhost during development

Rate limits, errors, and conventions

• Rate limits — current limits per tier, 429 response shape, back-off strategy
• Error reference — every error code with cause and remediation
• Pagination — cursor-based, consistent across list endpoints
• Versioning policy — what's stable, what isn't, deprecation cadence

Changelog

The API changelog is at /docs/api-changelog — subscribable via RSS for new endpoints, field additions, and deprecation notices. The product changelog (user-facing features) is at /changelog.

Getting help

• Engineering questions on the API: email api@link.boo or post in the developer Discord (link in your dashboard).
• Account-specific issues: support@link.boo with your request_id (every API response includes one).
• Security issues: security@link.boo (PGP key at /security).

Ready to start? Start a Pro trial or start an Agency trial.

Already have a token? Jump to the API overview →