GET
/
links
curl --request GET \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorization
string
headerrequired

Default authentication mechanism

Query Parameters

domain
string

The domain to filter the links by. E.g. ac.me. If not provided, all links for the workspace will be returned.

tagId
string
deprecated

The tag ID to filter the links by. This field is deprecated – use tagIds instead.

tagIds

The tag IDs to filter the links by.

tagNames

The unique name of the tags assigned to the short link (case insensitive).

search
string

The search term to filter the links by. The search term will be matched against the short link slug and the destination url.

userId
string

The user ID to filter the links by.

showArchived
boolean
default: false

Whether to include archived links in the response. Defaults to false if not provided.

withTags
boolean
default: false

Whether to include tags in the response. Defaults to false if not provided.

sort
enum<string>
default: createdAt

The field to sort the links by. The default is createdAt, and sort order is always descending.

Available options:
createdAt,
clicks,
lastClicked
page
integer

The page number for pagination (each page contains 100 links).

Response

200 - application/json
id
string
required

The unique ID of the short link.

domain
string
required

The domain of the short link. If not provided, the primary domain for the workspace will be used (or dub.sh if the workspace has no domains).

key
string
required

The short link slug. If not provided, a random 7-character slug will be generated.

externalId
string | null
required

This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.

url
string
required

The destination URL of the short link.

trackConversion
boolean
default: falserequired

[BETA] Whether to track conversions for the short link.

archived
boolean
default: falserequired

Whether the short link is archived.

expiresAt
string | null
required

The date and time when the short link will expire in ISO-8601 format.

expiredUrl
string | null
required

The URL to redirect to when the short link has expired.

password
string | null
required

The password required to access the destination URL of the short link.

proxy
boolean
default: falserequired

Whether the short link uses Custom Social Media Cards feature.

title
string | null
required

The title of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.

description
string | null
required

The description of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.

image
string | null
required

The image of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.

rewrite
boolean
default: falserequired

Whether the short link uses link cloaking.

doIndex
boolean
default: falserequired

Whether to allow search engines to index the short link.

ios
string | null
required

The iOS destination URL for the short link for iOS device targeting.

android
string | null
required

The Android destination URL for the short link for Android device targeting.

geo
object | null
required

Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }. Learn more: https://d.to/geo

publicStats
boolean
default: falserequired

Whether the short link's stats are publicly accessible.

tagId
string | null
requireddeprecated

The unique ID of the tag assigned to the short link. This field is deprecated – use tags instead.

tags
object[] | null
required

The tags assigned to the short link.

comments
string | null
required

The comments for the short link.

shortLink
string
required

The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).

qrCode
string
required

The full URL of the QR code for the short link (e.g. https://api.dub.co/qr?url=https://dub.sh/try).

utm_source
string | null
required

The UTM source of the short link.

utm_medium
string | null
required

The UTM medium of the short link.

utm_campaign
string | null
required

The UTM campaign of the short link.

utm_term
string | null
required

The UTM term of the short link.

utm_content
string | null
required

The UTM content of the short link.

userId
string
required

The user ID of the creator of the short link.

workspaceId
string
required

The workspace ID of the short link.

clicks
number
default: 0required

The number of clicks on the short link.

lastClicked
string | null
required

The date and time when the short link was last clicked.

leads
number
default: 0required

[BETA]: The number of leads the short links has generated.

sales
number
default: 0required

[BETA]: The number of sales the short links has generated.

createdAt
string
required

The date and time when the short link was created.

updatedAt
string
required

The date and time when the short link was last updated.

projectId
string
requireddeprecated

The project ID of the short link. This field is deprecated – use workspaceId instead.