Workspace
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.Workspace model
Workspace model
string
required
The unique ID of the workspace.
string
required
The name of the workspace.
string
required
The slug of the workspace.
string | null
required
The logo of the workspace.
number
required
The usage of the workspace.
number
required
The usage limit of the workspace.
number
required
The links usage of the workspace.
number
required
The links limit of the workspace.
number
required
The domains limit of the workspace.
number
required
The tags limit of the workspace.
number
required
The users limit of the workspace.
string
required
The plan of the workspace.
string | null
required
The Stripe ID of the workspace.
number
required
The date and time when the billing cycle starts for the workspace.
string
required
The date and time when the workspace was created.
object[]
required
The role of the authenticated user in the workspace.
object[]
required
The domains of the workspace.
Links
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.Link model
Link model
string
required
The unique ID of the short link. Prefixed with
link_.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).
string
required
The short link slug. If not provided, a random 7-character slug will be
generated.
string
required
The destination URL of the short link.
string
required
The full URL of the short link, including the https protocol (e.g.
https://d.to/try).boolean
default:"false"
Whether to track conversions for the short link.
string | null
The ID of the link in your database. If set, it can be used to identify the
link in future API requests (must be prefixed with
ext_ when passed as a
query parameter). This key is unique across your workspace.string | null
The ID of the tenant that created the link inside your system. If set, it can
be used to fetch all links for a tenant.
boolean
default:"false"
required
Whether the short link is archived.
string | null
The date and time when the short link will expire in ISO-8601 format.
string | null
The URL to redirect to when the short link has expired.
string | null
The password required to access the destination URL of the short link.
boolean
default:"false"
required
Whether the short link uses Custom Social Media Cards feature.
string | null
The title of the short link generated via api.dub.co/metatags. Will be used
for Custom Social Media Cards if proxy is true.
string | null
The description of the short link generated via api.dub.co/metatags. Will be
used for Custom Social Media Cards if proxy is true.
string | null
The image of the short link generated via api.dub.co/metatags. Will be used
for Custom Social Media Cards if proxy is true.
string | null
The custom link preview video (og:video). Will be used for Custom Social Media
Cards if
proxy is true. Learn more: https://d.to/ogboolean
default:"false"
required
Whether the short link uses link cloaking.
boolean
default:"false"
required
Whether to allow search engines to index the short link.
string | null
The iOS destination URL for the short link for iOS device targeting.
string | null
The Android destination URL for the short link for Android device targeting.
boolean
default:"false"
required
Whether the short link’s stats are publicly accessible.
object[] | null
The tags assigned to the short link.
string[]
The IDs of the webhooks that the short link is associated with.
string | null
The comments for the short link.
string
The full URL of the QR code for the short link (e.g.
https://api.dub.co/qr?url=https://d.to/try).string | null
The UTM source of the short link.
string | null
The UTM medium of the short link.
string | null
The UTM campaign of the short link.
string | null
The UTM term of the short link.
string | null
The UTM content of the short link.
string
The user ID of the creator of the short link.
string
The workspace ID of the short link.
number
default:"0"
required
The number of clicks on the short link.
number
default:"0"
required
The number of leads the short link has generated.
number
default:"0"
required
The number of sales the short link has generated.
number
default:"0"
required
The total dollar amount of sales the short link has generated (in cents).
string | null
The date and time when the short link was last clicked.
string
The date and time when the short link was created.
string
The date and time when the short link was last updated.
string | null
The ID of the program the short link is associated with.
Domains
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).Domain model
Domain model
string
required
The unique identifier of the domain.
string
required
The domain name.
boolean
default:false
required
Whether the domain is verified.
boolean
default:false
required
Whether the domain is the primary domain for the workspace.
boolean
default:false
required
Whether the domain is archived.
string
default:"https://dub.co/help/article/what-is-dub"
required
Provide context to your teammates in the link creation modal by showing them
an example of a link to be shortened.
string | null
required
The URL to redirect to when a link under this domain has expired.
string | null
required
The URL to redirect to when a link under this domain doesn’t exist.
string
required
The date the domain was created.
string
required
The date the domain was last updated.
object | null
required
The registered domain record.