Link

A Link is a shortened URL together with its metadata: the destination it redirects to, its short path, and click statistics. You create one either individually or in bulk (up to 10,000 at once), then reference it by its id.

Key fields

Field Description
id UUID identifying the link.
path The short path segment (e.g. zgdssgd). Auto-generated if not supplied at creation, unless you provide your own.
shortUrl The full shareable short URL (domain + path).
longUrl The destination URL the short link redirects to.
title A human-readable label for the link.
domain UUID of the Domain the link is served from.
tags Free-form string tags for organizing links.
totalNumberOfClick Running total of clicks recorded against this link.
expiredAt Optional expiration timestamp; after this time the link is expired (see below). Null means the link never expires.
createdAt / updatedAt Timestamps. updatedAt is null until the link is modified.

Bulk creation additionally accepts domain_id, external_id (your own ID for the link, for cross-referencing), and team per item — see Bulk-import links.

Lifecycle

A link has no explicit status field — its state is derived from expiredAt:

  • Active — expiredAt is null, or in the future. The short URL redirects normally.
  • Expired — expiredAt is in the past. The link still exists and is still retrievable via the API, but is no longer expected to redirect visitors.

See the Link tag in the API Reference: create, bulk-create, list, and get-by-id.