API Docs
v1
OpenAPI 3.1
JSON API

Shortify API for links, deep links, analytics, and attribution.

Build server-side link workflows, read customer-owned analytics, and connect SDK attribution flows with the implemented Shortify v1 API. These docs describe only production customer APIs.

Base URL

https://api.shortify.com
OpenAPI JSONBrowse reference
Authentication
Links
Deep Links
Client APIs
Analytics
Migration

Server Quickstart

Create links from your backend with a workspace Server API Key. Use an idempotency key for retry-safe create requests.

Create a short link
curl -X POST "https://api.shortify.com/v1/links" \
  -H "api-key: sk_live_your_server_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pricing-2026-create" \
  --data '{
    "url": "https://example.com/pricing",
    "domain": "go.example.com",
    "key": "pricing-2026",
    "title": "Pricing campaign",
    "tags": ["pricing", "email"],
    "objects": {"campaign": "spring-2026"},
    "tracking": {"utmSource": "newsletter"}
  }'

Client Quickstart

SDKs and trusted clients use publishable keys only for resolve, click attribution, deferred deep-link lookup, first-open, and customer event publishing.

Record a client click
curl -X POST "https://api.shortify.com/v1/client/attribution/click" \
  -H "x-publishable-key: pk_live_your_publishable_key" \
  -H "x-shortify-platform: android" \
  -H "Content-Type: application/json" \
  --data '{
    "shortLink": "https://go.example.com/invite-abc",
    "sessionId": "anon-session-123",
    "installId": "install-456"
  }'

API Surface

Customer-facing v1 endpoints are grouped by integration job. Webhook management is not part of this API surface.

Full endpoint overview

Links

Create, list, retrieve, update, and archive standard short links.

GET
/v1/links

List standard short links with search, filtering, sorting, and cursor pagination.

POST
/v1/links

Create a short link with JSON fields for destination, domain, tags, tracking, and metadata.

GET
/v1/links/{linkId}

Retrieve a link by stable resource ID. PATCH updates it, and DELETE archives it.

Deep Links

Create and manage deep links using app configuration from the web panel.

GET
/v1/deep-links

List deep links owned by the workspace with the same filters as standard links.

POST
/v1/deep-links

Create a deep link bound to an existing deep-link app configuration.

GET
/v1/deep-links/{linkId}

Retrieve, update, or archive a deep link by stable resource ID.

Domains

Read verified and archived domain inventory. Domain setup stays in the web panel.

GET
/v1/domains

List domains with search, exact-domain filtering, archived filtering, sorting, and cursor pagination.

GET
/v1/domains/{domainId}

Retrieve a single domain by ID.

Analytics

Read link analytics, deep-link-app analytics, and raw event exports.

GET
/v1/analytics/links/{linkId}

Return summary, time series, breakdowns, recent events, and LaunchView metrics for one link.

GET
/v1/analytics/deep-link-app

Return app-level analytics for the app resolved from the provided App API Key.

GET
/v1/analytics/events

Export click, LaunchView, install, first-open, and customer-event rows with cursor pagination.

Client APIs

Publishable-key endpoints for SDKs, attribution, deferred deep links, and customer events.

POST
/v1/client/resolve

Resolve a link from linkId, shortLink, or domain and key.

POST
/v1/client/attribution/click

Create click and attribution IDs for SDK-driven deferred deep-link flows.

POST
/v1/client/deferred-deep-link

Look up and consume a matching deferred deep-link payload.

POST
/v1/client/first-open

Record install or first-open attribution and return a matched deferred payload when available.

POST
/v1/client/events

Queue up to 50 link-bound product events such as signup, purchase, or trial_started.

Core Rules

JSON by default

v1 endpoints accept application/json and return a consistent response envelope with requestId.

Stable resource IDs

Create and list responses return IDs used for retrieve, update, delete/archive, and analytics calls.

Scoped credentials

Server keys manage workspace resources. Publishable keys are limited to client attribution endpoints.

No management shortcuts

Apps, domains, webhooks, QR behavior, billing, and key lifecycle stay outside the public customer API.