Reference

API Reference

All v1 requests use https://api.shortify.com. The public API is limited to customer-owned links, deep links, read-only domains, analytics, and client attribution.

LinksOpen

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

GET

/v1/links

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

Server API Key - Stable

POST

/v1/links

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

Server API Key - Stable

GET

/v1/links/{linkId}

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

Server API Key - Stable

Deep LinksOpen

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.

Server API Key - Stable

POST

/v1/deep-links

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

Server API Key - Stable

GET

/v1/deep-links/{linkId}

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

Server API Key - Stable

DomainsOpen

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.

Server API Key - Read-only

GET

/v1/domains/{domainId}

Retrieve a single domain by ID.

Server API Key - Read-only

AnalyticsOpen

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.

Server API Key - Stable

GET

/v1/analytics/deep-link-app

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

App API Key - Stable

GET

/v1/analytics/events

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

Server API Key - Stable

Client APIsOpen

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.