Skip to main content
GET
List Shortlinks

Authorizations

X-API-Key
string
header
required

Your API key, for example dlk_live_.... Create one in the dashboard under Settings → API Keys. Keys are shown once at creation and stored only as a hash, so they cannot be recovered.

Query Parameters

page
string
default:1

1-based page number. Defaults to 1.

per_page
string
default:10

Results per page. Defaults to 10, maximum 100. Larger values are clamped, not rejected.

date_from
string

Start of the window, YYYY-MM-DD. Clamped to your plan's retention floor.

date_to
string

End of the window, YYYY-MM-DD.

custom_backhalf
string

Filter to links that use a custom (chosen) back-half rather than a generated one.

sort_by
string
default:last_modified

Sort key: name, most_recent or last_modified.

order
string
default:desc

Sort direction: asc or desc.

tags
string

Tag names to filter by.

Kind of link: shortlink or dynamic_link. Defaults to shortlink.

enabled
string

Filter by enabled state.

password_protected
string

Whether the link requires a password.

dynamic_routing_enabled
string

Whether routing_rules are evaluated for this link. When off, the base destination is always served. Defaults to false.

Whether the link stops resolving after expires_at. Defaults to false.

is_custom_preview
string

Whether the link uses custom link-preview metadata (preview_title, preview_description, preview_image) instead of an auto-generated preview. Defaults to false.

utm_analytics_enabled
string

Whether UTM parameters are appended to the destination and tracked. Defaults to false.

qr_code_enabled
string

Whether to generate a QR code for this link. Defaults to false.

destination_types
string

Filter the list to these destination types, comma-separated (url, wifi, sms, call, email, vcard).

Response

Success.

data
object

The endpoint's payload.