Workspaces is the defacto way of organizing your links and working with your team on Dub. You can think of a Dub workspace like a workspace on Slack or Discord – it’s a shared space where you can invite your team members to collaborate on links.
When interacting with Dub’s API, you’ll also need to create a workspace API key to authenticate your requests.
id
string
required
The unique ID of the workspace.
name
string
required
The name of the workspace.
slug
string
required
The slug of the workspace.
logo
string | null
required
The logo of the workspace.
usage
number
required
The usage of the workspace.
usageLimit
number
required
The usage limit of the workspace.
linksUsage
number
required
The links usage of the workspace.
linksLimit
number
required
The links limit of the workspace.
domainsLimit
number
required
The domains limit of the workspace.
tagsLimit
number
required
The tags limit of the workspace.
usersLimit
number
required
The users limit of the workspace.
plan
string
required
The plan of the workspace.
stripeId
string | null
required
The Stripe ID of the workspace.
billingCycleStart
number
required
The date and time when the billing cycle starts for the workspace.
createdAt
string
required
The date and time when the workspace was created.
users
object[]
required
The role of the authenticated user in the workspace.
users.role
string
required
The role of the authenticated user in the workspace.
Links are the bread and butter of Dub. You can shorten any URL to a Dub link, which you can then share with your audience. Links can be created, updated, and deleted via the Dub API or the Dub dashboard.
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 provided to
links.get, links.update, and links.delete methods.
url
string
required
The destination URL of the short link.
archived
boolean
default: "false"required
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: "false"required
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: "false"required
Whether the short link uses link cloaking.
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.
publicStats
boolean
default: "false"required
Whether the short link’s stats are publicly accessible.
tagId
string | null
required
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.
tags.id
string
required
The unique ID of the tag.
tags.name
string
required
The name of the tag.
tags.color
string
required
The color of the tag.
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: "0"required
The number of clicks on the short link.
lastClicked
string | null
required
The date and time when the short link was last clicked.
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
required
The project ID of the short link. This field is deprecated – use workspaceId
instead.
On Dub, you can add custom domains to create branded short links for better brand recognition. You can also set a primary domain for it to be used as the default domain for new links (both via the API and the dashboard).
id
string
required
The unique identifier of the domain.
slug
string
required
The domain name.
verified
boolean
default: falserequired
Whether the domain is verified.
primary
boolean
default: falserequired
Whether the domain is the primary domain for the workspace.
Tags are a way to organize your links. You can add tags to your links to categorize them and make them easier to find. You can also filter analytics by tags to get a better understanding of how your campaigns are performing.
