LIlinklyhq
Links

Get link details

Changed on

Retrieve a specific link by its ID: destination, short URL, UTM parameters, rules and configuration. Click counts are not included — use getClicks for a time series, or listLinks for per-link totals.

get/api/v1/link/{id}

Request

Path parameters

idstring required

The id of the Link

Query parameters

workspace_idstring

Workspace ID. Optional when using OAuth2 Bearer token.

Response

Link

fb_pixel_idstring nullable
linkedin_partner_idstring nullable
microsoft_uet_tag_idstring nullable
reddit_pixel_idstring nullable
tiktok_pixel_idstring nullable
hide_referrerboolean nullable
expiry_datetimestring nullable
expiry_destinationstring uri nullable
twitter_pixel_idstring nullable
cloakingboolean nullable
linkify_wordsstring nullable
full_urlstring uri
sticky_rotatorboolean

Rotator links only: a visitor who has been sent to one of the rotator's destinations is sent to the same one again when they click the link again, remembered in a cookie for 30 days.

og_descriptionstring nullable
skip_social_crawler_trackingboolean nullable
body_tagsstring nullable
og_titlestring nullable
notestring nullable
namestring nullable
idinteger
gtm_idstring nullable
og_imagestring nullable
block_botsboolean nullable
snapchat_pixel_idstring nullable
utm_contentstring nullable
enabledboolean nullable
privacy_modeboolean

Privacy mode: clicks are counted, but no IP address, location, network, user agent, referrer or query parameters are stored, and click times are kept to the hour. Paid plans only.

urlstring uri
replacementsstring nullable
deletedboolean nullable
qr_stylesobject nullable
webhooksstring[] nullable
created_by_user_idinteger nullable
expiry_clicksinteger nullable
notify_slackboolean nullable
notify_user_idsinteger[] nullable
workspace_idinteger
public_analyticsboolean nullable
pinterest_tag_idstring nullable
passwordstring nullable
utm_sourcestring nullable
slugstring nullable
domainstring nullable
forward_paramsboolean nullable
utm_mediumstring nullable
head_tagsstring nullable
ga4_tag_idstring nullable
utm_termstring nullable
utm_campaignstring nullable

Example response

{
  "fb_pixel_id": null,
  "linkedin_partner_id": null,
  "microsoft_uet_tag_id": null,
  "reddit_pixel_id": null,
  "tiktok_pixel_id": null,
  "hide_referrer": false,
  "expiry_datetime": null,
  "expiry_destination": null,
  "rules": [],
  "twitter_pixel_id": null,
  "cloaking": false,
  "linkify_words": null,
  "full_url": "https://l.linklyhq.com/l/1uXyz",
  "sticky_rotator": false,
  "og_description": null,
  "skip_social_crawler_tracking": false,
  "body_tags": null,
  "og_title": null,
  "note": null,
  "name": "Summer sale — newsletter",
  "id": 41657524,
  "gtm_id": null,
  "og_image": null,
  "block_bots": false,
  "snapchat_pixel_id": null,
  "utm_content": null,
  "enabled": true,
  "privacy_mode": false,
  "url": "https://www.example.com/summer-sale?ref=newsletter",
  "replacements": null,
  "deleted": false,
  "qr_styles": null,
  "webhooks": [],
  "created_by_user_id": 7,
  "expiry_clicks": null,
  "notify_slack": false,
  "notify_user_ids": [],
  "workspace_id": 42,
  "public_analytics": false,
  "pinterest_tag_id": null,
  "password": null,
  "utm_source": "newsletter",
  "slug": null,
  "domain": null,
  "forward_params": false,
  "utm_medium": "email",
  "head_tags": null,
  "ga4_tag_id": null,
  "utm_term": null,
  "utm_campaign": "summer_sale"
}

Changes