Links API
36 REST endpoints for links, each with its parameters, the response it returns and a runnable curl example. Starts with GET /api/links.
GET/api/linksLink list
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 8
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
limit | query | Optional query parameter |
offset | query | Optional query parameter |
q | query | Optional query parameter |
folderId | query | Optional query parameter |
tag | query | Optional query parameter |
sort | query | Optional query parameter |
dir | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/linksCreate a short link
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 52
| Name | In | Description |
|---|---|---|
path | body | JSON request field |
slug | body | JSON request field |
original_url | body | JSON request field |
title | body | JSON request field |
description | body | JSON request field |
tags | body | JSON request field |
folder_id | body | JSON request field |
cloaking | body | JSON request field |
password_contact | body | JSON request field |
note | body | JSON request field |
expires_at | body | JSON request field |
expired_url | body | JSON request field |
ttl | body | JSON request field |
clicks_limit | body | JSON request field |
utm_source | body | JSON request field |
utm_medium | body | JSON request field |
utm_campaign | body | JSON request field |
utm_term | body | JSON request field |
utm_content | body | JSON request field |
android_url | body | JSON request field |
iphone_url | body | JSON request field |
android_package | body | JSON request field |
android_action | body | JSON request field |
android_component | body | JSON request field |
split_urls | body | JSON request field |
rotation | body | JSON request field |
redirect_type | body | JSON request field |
skip_qs | body | JSON request field |
url_policy | body | JSON request field |
archived | body | JSON request field |
geo_rules | body | JSON request field |
integration_ga | body | JSON request field |
integration_gtm | body | JSON request field |
integration_fb | body | JSON request field |
integration_adroll | body | JSON request field |
tracking_settings | body | JSON request field |
tracking_code | body | JSON request field |
og | body | JSON request field |
twitter | body | JSON request field |
app_links | body | JSON request field |
qr_style | body | JSON request field |
permissions | body | JSON request field |
bundle_id | body | JSON request field |
routing_rules | body | JSON request field |
app_deep_link | body | JSON request field |
referrer_rules | body | JSON request field |
returning_rule | body | JSON request field |
click_alerts | body | JSON request field |
bot_policy | body | JSON request field |
password | body | JSON request field |
encrypt | body | JSON request field |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/links/{id}Delete a short link
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/{id}Get link info by link ID
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/previewRead a destination page's title, description, site name and favicon (SSRF-safe, cached 24 h)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
url | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/suggestSlug and tag suggestions for a destination (instant heuristics; ai:true refines with the configured provider)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 6
| Name | In | Description |
|---|---|---|
url | body | JSON request field |
title | body | JSON request field |
kind | body | JSON request field |
domainId | body | JSON request field |
ai | body | JSON request field |
variant | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/links/{id}/click-alertsRecent click alerts for one link
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
PATCH/api/links/{id}Update a short link (PATCH)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 53
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
original_url | body | JSON request field |
title | body | JSON request field |
description | body | JSON request field |
tags | body | JSON request field |
folder_id | body | JSON request field |
cloaking | body | JSON request field |
password_contact | body | JSON request field |
note | body | JSON request field |
expires_at | body | JSON request field |
expired_url | body | JSON request field |
ttl | body | JSON request field |
clicks_limit | body | JSON request field |
utm_source | body | JSON request field |
utm_medium | body | JSON request field |
utm_campaign | body | JSON request field |
utm_term | body | JSON request field |
utm_content | body | JSON request field |
android_url | body | JSON request field |
iphone_url | body | JSON request field |
android_package | body | JSON request field |
android_action | body | JSON request field |
android_component | body | JSON request field |
split_urls | body | JSON request field |
rotation | body | JSON request field |
redirect_type | body | JSON request field |
skip_qs | body | JSON request field |
url_policy | body | JSON request field |
archived | body | JSON request field |
geo_rules | body | JSON request field |
integration_ga | body | JSON request field |
integration_gtm | body | JSON request field |
integration_fb | body | JSON request field |
integration_adroll | body | JSON request field |
tracking_settings | body | JSON request field |
tracking_code | body | JSON request field |
og | body | JSON request field |
twitter | body | JSON request field |
app_links | body | JSON request field |
qr_style | body | JSON request field |
permissions | body | JSON request field |
bundle_id | body | JSON request field |
routing_rules | body | JSON request field |
app_deep_link | body | JSON request field |
referrer_rules | body | JSON request field |
returning_rule | body | JSON request field |
click_alerts | body | JSON request field |
bot_policy | body | JSON request field |
path | body | JSON request field |
slug | body | JSON request field |
password | body | JSON request field |
encrypt | body | JSON request field |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}Update a short link
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 53
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
original_url | body | JSON request field |
title | body | JSON request field |
description | body | JSON request field |
tags | body | JSON request field |
folder_id | body | JSON request field |
cloaking | body | JSON request field |
password_contact | body | JSON request field |
note | body | JSON request field |
expires_at | body | JSON request field |
expired_url | body | JSON request field |
ttl | body | JSON request field |
clicks_limit | body | JSON request field |
utm_source | body | JSON request field |
utm_medium | body | JSON request field |
utm_campaign | body | JSON request field |
utm_term | body | JSON request field |
utm_content | body | JSON request field |
android_url | body | JSON request field |
iphone_url | body | JSON request field |
android_package | body | JSON request field |
android_action | body | JSON request field |
android_component | body | JSON request field |
split_urls | body | JSON request field |
rotation | body | JSON request field |
redirect_type | body | JSON request field |
skip_qs | body | JSON request field |
url_policy | body | JSON request field |
archived | body | JSON request field |
geo_rules | body | JSON request field |
integration_ga | body | JSON request field |
integration_gtm | body | JSON request field |
integration_fb | body | JSON request field |
integration_adroll | body | JSON request field |
tracking_settings | body | JSON request field |
tracking_code | body | JSON request field |
og | body | JSON request field |
twitter | body | JSON request field |
app_links | body | JSON request field |
qr_style | body | JSON request field |
permissions | body | JSON request field |
bundle_id | body | JSON request field |
routing_rules | body | JSON request field |
app_deep_link | body | JSON request field |
referrer_rules | body | JSON request field |
returning_rule | body | JSON request field |
click_alerts | body | JSON request field |
bot_policy | body | JSON request field |
path | body | JSON request field |
slug | body | JSON request field |
password | body | JSON request field |
encrypt | body | JSON request field |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
PUT/api/links/{id}Update a short link (PUT)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/approvalCreate or update links by ID approval
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
note | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/archiveArchive a short link
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/{id}/countryList country targeting rules
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/countryReplace country targeting rules
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
value | body | JSON request field |
url | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/destination-schedulesCreate or update links by ID destination schedules
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
destination | body | JSON request field |
executeAt | body | JSON request field |
timezone | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/links/{id}/destination-schedules/{scheduleId}Delete links by ID destination schedules :scheduleId
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
scheduleId | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/duplicateCreate or update links by ID duplicate
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/links/{id}/qrGet links by ID qr
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 13
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
theme | query | Optional query parameter |
fg | query | Optional query parameter |
bg | query | Optional query parameter |
eye | query | Optional query parameter |
radius | query | Optional query parameter |
finder | query | Optional query parameter |
dots | query | Optional query parameter |
ecl | query | Optional query parameter |
size | query | Optional query parameter |
label | query | Optional query parameter |
utm | query | Optional query parameter |
format | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/{id}/regionList region targeting rules
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/regionReplace region targeting rules
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
value | body | JSON request field |
url | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/routing-rulesCreate or update links by ID routing rules
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
rules | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/{id}/unarchiveUnarchive a short link
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/{id}/workflowGet links by ID workflow
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/bulkCreate short links in bulk
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
links | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/bulk/actionBulk actions from the links table
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
ids | body | JSON request field |
payload | body | JSON request field |
action | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/links/bulk/deleteCreate or update links bulk delete
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
action | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/links/by-original-urlGet link info by original URL
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
originalURL | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/by-original-urlsGet links info by original URL
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
originalURL | query | Optional query parameter |
limit | query | Optional query parameter |
offset | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/by-pathGet link info by path
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
path | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/expandExpand a short link
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domain | query | Optional query parameter |
path | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/foldersCreate a folder
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/links/folders/{domainId}List folders in a domain
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
domainId | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/links/folders/{domainId}/{folderId}Get folder details
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domainId | path | Required path parameter |
folderId | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/multipleCreate or update links multiple
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
ids | body | JSON request field |
link_ids | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/links/opengraph/{domainId}/{linkId}Get link Open Graph properties
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domainId | path | Required path parameter |
linkId | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/links/qr/bulkCreate or update links qr bulk
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
ids | body | JSON request field |
format | body | JSON request field |
style | body | JSON request field |
Examples in 22 languages and Try it →