Retrieve a list of links
Retrieve a paginated list of links for the authenticated workspace.
Authorizations
Default authentication mechanism
Query Parameters
The domain to filter the links by. E.g. ac.me. If not provided, all links for the workspace will be returned.
The tag ID to filter the links by. This field is deprecated – use tagIds instead.
The tag IDs to filter the links by.
The unique name of the tags assigned to the short link (case insensitive).
The search term to filter the links by. The search term will be matched against the short link slug and the destination url.
The user ID to filter the links by.
Whether to include archived links in the response. Defaults to false if not provided.
DEPRECATED. Filter for links that have at least one tag assigned to them.
The field to sort the links by. The default is createdAt, and sort order is always descending.
createdAt, clicks, lastClicked The page number for pagination.
The number of items per page.
Response
The unique ID of the short link.
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).
The short link slug. If not provided, a random 7-character slug will be generated.
The destination URL of the short link.
[BETA] Whether to track conversions for the short link.
This is the ID of the link in your database that is unique across your workspace. 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.
The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
Whether the short link is archived.
The date and time when the short link will expire in ISO-8601 format.
The URL to redirect to when the short link has expired.
The password required to access the destination URL of the short link.
Whether the short link uses Custom Social Media Cards feature.
The title of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
The description of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
The image of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
The custom link preview video (og:video). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
Whether the short link uses link cloaking.
Whether to allow search engines to index the short link.
The iOS destination URL for the short link for iOS device targeting.
The Android destination URL for the short link for Android device targeting.
Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }. Learn more: https://d.to/geo
Whether the short link's stats are publicly accessible.
The unique ID of the tag assigned to the short link. This field is deprecated – use tags instead.
The tags assigned to the short link.
The IDs of the webhooks that the short link is associated with.
The comments for the short link.
The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).
The full URL of the QR code for the short link (e.g. https://api.dub.co/qr?url=https://dub.sh/try).
The UTM source of the short link.
The UTM medium of the short link.
The UTM campaign of the short link.
The UTM term of the short link.
The UTM content of the short link.
The user ID of the creator of the short link.
The workspace ID of the short link.
The number of clicks on the short link.
The date and time when the short link was last clicked.
[BETA]: The number of leads the short links has generated.
[BETA]: The number of sales the short links has generated.
[BETA]: The total dollar amount of sales the short links has generated (in cents).
The date and time when the short link was created.
The date and time when the short link was last updated.
The project ID of the short link. This field is deprecated – use workspaceId instead.
Was this page helpful?