← Tools Reference

Linkly

Linkly integration (Marketing, Data). Imported from open-connector.

API key6 toolshttps://api.linklyhq.com
GET
linkly_list_workspaces
List Linkly workspaces available to the authenticated API key.

/api/v1/workspaces

GET
linkly_list_links
List links in a Linkly workspace with optional search, filters, and pagination.

/api/v1/workspace/{workspace_id}/list_links

7 parameters
ParamTypeRequiredDescription
workspace_idstringrequiredThe Linkly workspace ID.
searchstringoptionalSearch query.
pageintegeroptionalPage number.
page_sizeintegeroptionalNumber of links to return.
sort_bystringoptionalField used to sort links.
sort_dirstringoptionalSort direction.
filterobjectoptionalExact-match filters for listing Linkly workspace links.
GET
linkly_get_link
Get a Linkly link by ID, optionally scoped to a workspace.

/api/v1/link/{id}

2 parameters
ParamTypeRequiredDescription
idintegerrequiredThe Linkly link ID.
workspace_idstringoptionalThe Linkly workspace ID.
POST
linkly_create_link
Create a Linkly short link in a workspace.

/api/v1/workspace/{workspace_id}/links

33 parameters
ParamTypeRequiredDescription
workspace_idstringrequiredThe Linkly workspace ID.
urlstringrequiredThe destination URL.
domainstringoptional
domain_idintegeroptionalDomain ID, used as an alternative to domain.
slugstringoptional
namestringoptional
notestringoptional
enabledbooleanoptionalWhether the link is active.
forward_paramsbooleanoptionalWhether to forward query parameters to the destination.
utm_sourcestringoptional
utm_mediumstringoptional
utm_campaignstringoptional
utm_termstringoptional
utm_contentstringoptional
expiry_datetimestringoptional
expiry_destinationstringoptional
expiry_clicksintegeroptional
public_analyticsbooleanoptionalWhether analytics are publicly accessible.
block_botsbooleanoptionalWhether to block bot traffic.
hide_referrerbooleanoptionalWhether to hide the referrer from the destination.
cloakingbooleanoptionalWhether link cloaking is enabled.
gtm_idstringoptional
ga4_tag_idstringoptional
fb_pixel_idstringoptional
tiktok_pixel_idstringoptional
og_titlestringoptional
og_descriptionstringoptional
og_imagestringoptional
head_tagsstringoptional
body_tagsstringoptional
linkify_wordsstringoptional
replacementsstringoptional
rulesarrayoptionalRedirect rules for the link.
POST
linkly_update_link
Update a Linkly short link in a workspace.

/api/v1/workspace/{workspace_id}/links

34 parameters
ParamTypeRequiredDescription
workspace_idstringrequiredThe Linkly workspace ID.
idintegerrequiredThe Linkly link ID.
urlstringoptionalThe destination URL.
domainstringoptional
domain_idintegeroptionalDomain ID, used as an alternative to domain.
slugstringoptional
namestringoptional
notestringoptional
enabledbooleanoptionalWhether the link is active.
forward_paramsbooleanoptionalWhether to forward query parameters to the destination.
utm_sourcestringoptional
utm_mediumstringoptional
utm_campaignstringoptional
utm_termstringoptional
utm_contentstringoptional
expiry_datetimestringoptional
expiry_destinationstringoptional
expiry_clicksintegeroptional
public_analyticsbooleanoptionalWhether analytics are publicly accessible.
block_botsbooleanoptionalWhether to block bot traffic.
hide_referrerbooleanoptionalWhether to hide the referrer from the destination.
cloakingbooleanoptionalWhether link cloaking is enabled.
gtm_idstringoptional
ga4_tag_idstringoptional
fb_pixel_idstringoptional
tiktok_pixel_idstringoptional
og_titlestringoptional
og_descriptionstringoptional
og_imagestringoptional
head_tagsstringoptional
body_tagsstringoptional
linkify_wordsstringoptional
replacementsstringoptional
rulesarrayoptionalRedirect rules for the link.
DELETE
linkly_delete_link
Delete a Linkly short link from a workspace.

/api/v1/workspace/{workspace_id}/links/{id}

2 parameters
ParamTypeRequiredDescription
workspace_idstringrequiredThe Linkly workspace ID.
idintegerrequiredThe Linkly link ID.