Skip to main content

Base URL

All API requests should be made to:

Authentication

Public API endpoints are authenticated via API key in the X-API-Key header. Dashboard/session endpoints use session authentication and CSRF protection.
See Authentication for details.

Request Format

  • All request bodies must be JSON
  • Include Content-Type: application/json header for POST/PUT/PATCH requests

Response Format

All responses follow a consistent format:

Success Response

Success Response (List)

Error Response

HTTP Status Codes

Common Error Codes

Pagination

List endpoints support pagination:

Filtering

Many list endpoints support filtering:

Timestamps

All timestamps are returned in ISO 8601 format (UTC):

IDs

Resources use prefixed IDs for easy identification:

API Endpoints

Links

Create and manage smart links

Rules

Configure routing rules

Campaigns

Organize links into campaigns

Analytics

Access click and conversion data

Conversions

Track conversion events

Pixels

Manage tracking pixels

Advanced Modules

Workspace, billing, integrations, affiliate, partner, and security APIs

Workspaces

Manage workspaces, members, invitations, and ownership transfer

Billing

Plans, credits, subscriptions, and auto-recharge APIs

Customers & Events

Customer entities, event streams, cohorts, and attribution APIs

Integrations

Integration install/configuration, provider callbacks, and outbound webhooks

Affiliate & Partner

Program-owner APIs, marketplace flows, and partner-portal APIs

Webhooks

Workspace, link-level, and automation webhook management

Auth & Settings

Session auth lifecycle, linked accounts, and user settings APIs

Domains & Organization

Domain onboarding, tags, folders, and UTM template APIs

Tracking Modules

QR, deep-link attribution, publishable key, and SDK tracking APIs

Data Operations

Search, bulk operations, imports, and async export pipelines

Utilities & Support

FX rates, notifications, feedback, metatags, email logs, and wrapped APIs

Identity & Enterprise

OAuth apps, SAML SSO, and SCIM provisioning APIs

Public & Embed

Public stats and embedded analytics/link creation surfaces