Dub.co Docs

API Reference

SDKs

Dashboard

Support

Help Center

Client-side JavaScript SDK for for Dub Conversions

Introduction

Dub is the link management platform for modern marketing teams.

Getting Started with Dub - Documentation

A quick overview of how Dub is structured.

Data model

Explore ideas and examples of what you can build with the Dub API

Dub.co API Examples - Build with the Dub API

Examples

Learn how to integrate Dub with TypeScript.

Next.js

Remix

Nuxt

Express

Flask

Django

Learn how to integrate Dub with Ruby on Rails.

Ruby on Rails

Sinatra

Laravel

Integrate Dub.co with your favorite tools and services.

Dub.co Integrations: Connect Dub.co to tools and services

Overview

Learn how to set up Dub OAuth applications to authenticate users with OAuth 2.0.

Integrate with Dub

Use webhooks to build custom integrations with Dub.

Dub.co Webhooks: Build custom integrations with Dub

Webhooks

Learn how to get started with Dub Conversions

Dub Conversions Quickstart

Quickstart

Learn how to track a lead conversion event with NextAuth.js and the Dub SDK

NextAuth.js Lead Tracking – Dub Conversions

NextAuth.js

Learn how to track a lead conversion event with Supabase Auth and the Dub SDK

Supabase Auth Lead Tracking – Dub Conversions

Supabase Auth

Learn how to track a lead conversion event with Auth0 and the Dub SDK

Auth0 Lead Tracking – Dub Conversions

Auth0

Learn how to track a lead conversion event with Clerk and the Dub SDK

Clerk Lead Tracking – Dub Conversions

Clerk

Learn how to track a sale conversion event with Stripe

Dub Conversions - Sales – Stripe

Stripe

Learn how to track a sale conversion event with Shopify

Dub Conversions - Sales – Shopify

Shopify

A guide on how to run Dub.co's codebase locally.

How to setup Dub.co for Local Development (6 steps)

Local Development

An end-to-end guide on how to self-host Dub.co – the open-source link management platform.

How to self-host Dub.co in 8 easy steps

Self-hosting Dub.co

Dub.co API Reference - Introduction

API Keys

What are Dub.co's API rate limits?

Rate limits

Learn how to paginate through resources in the API.

All endpoints that list resources support pagination.

Pagination

Troubleshoot problems with this comprehensive breakdown of all error codes.

Dub.co API returns machine readable error codes, human readable error messages and a link to the docs for more information

Errors

Create a new link for the authenticated workspace.

Create a new link with the Dub.co API - API Reference

Create a new link

Update a link for the authenticated workspace. If there's no change, returns it as it is.

Update a link with the Dub.co API - API Reference

Update a link

Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.

Upsert a link with the Dub.co API - API Reference

Upsert a link

Delete a link for the authenticated workspace.

Delete a link with the Dub.co API - API Reference

Delete a link

Get link info with the Dub.co API - API Reference

Retrieve a link

Retrieve a paginated list of links for the authenticated workspace.

Get list of links with the Dub.co API - API Reference

Retrieve a list of links

Retrieve the number of links for the authenticated workspace. The provided query parameters allow filtering the returned links.

Get the links count with the Dub.co API - API Reference

Retrieve links count

Bulk create up to 100 links for the authenticated workspace.

Bulk create links with the Dub.co API - API Reference

Bulk create links

Bulk update up to 100 links with the same data for the authenticated workspace.

Bulk update links with the Dub.co API - API Reference

Bulk update links

Bulk delete up to 100 links for the authenticated workspace.

Bulk delete links with the Dub.co API - API Reference

Bulk delete links

Get a QR code with the Dub.co API - API Reference

Retrieve a QR code

Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.

Retrieve analytics for a link, a domain, or the authenticated workspace. - API Reference

Retrieve analytics

Retrieve a paginated list of events for the authenticated workspace.

Retrieve a list of events with the Dub.co API - API Reference

Retrieve a list of events

Create a new tag for the authenticated workspace.

Create a new tag with the Dub.co API - API Reference

Create a new tag

Retrieve a list of tags for the authenticated workspace.

Get list of tags with the Dub.co API - API Reference

Retrieve a list of tags

Update a tag with the Dub.co API - API Reference

Update a tag

Create a domain for the authenticated workspace.

Create a domain for a workspace with the Dub.co API - API Reference

Create a domain

Update a domain for the authenticated workspace.

Update a domain with the Dub.co API - API Reference

Update a domain

Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.

Delete a domain from the workspace with the Dub.co API - API Reference

Delete a domain

Retrieve a list of domains associated with the authenticated workspace.

Get list of domains associated with the workspace with the Dub.co API - API Reference

Retrieve a list of domains

Retrieve a workspace for the authenticated user.

Get workspace info with the Dub.co API - API Reference

Retrieve a workspace

Update a workspace with the Dub.co API - API Reference

Update a workspace

Track a lead with the Dub.co API - API Reference

Track a lead

Track a sale with the Dub.co API - API Reference

Track a sale

Create a customer for the authenticated workspace.

Create a customer with the Dub.co API - API Reference

Create a customer

Update a customer for the authenticated workspace.

Update a customer with the Dub.co API - API Reference

Update a customer

Delete a customer with the Dub.co API - API Reference

Delete a customer

Retrieve a customer by ID for the authenticated workspace.

Retrieve a customer with the Dub.co API - API Reference

Retrieve a customer

Retrieve a list of customers for the authenticated workspace.

Retrieve a list of customers with the Dub.co API - API Reference

Retrieve a list of customers

Open-source client libraries for the Dub.co API

How to add Dub Analytics to your React or Next.js site

React

How to add Dub Analytics to your Webflow site

Webflow

How to add Dub Analytics to your WordPress site

WordPress

How to add Dub Analytics to your Framer site

Framer

dub.links.create - Create a new link - TypeScript SDK

Create

Retrieve info for a link by specifying either the domain and key or the linkId or externalId

dub.links.get - Retrieve a link - TypeScript SDK

Edit a link for the authenticated workspace. Support partial updates.

dub.links.update - Edit a link - TypeScript SDK

Update

dub.links.upsert - Upsert a new link - TypeScript SDK

Upsert

dub.links.delete - Delete a link - TypeScript SDK

Delete

Retrieve a list of links for the authenticated workspace. The list will be paginated and the provided query parameters allow filtering the returned links.

dub.links.list - Retrieve a list of links - TypeScript SDK

List

dub.links.count - Retrieve the number of links - TypeScript SDK

Count

dub.links.createMany - Bulk create links - TypeScript SDK

Create Many

Retrieve

dub.analytics.retrieve

Retrieve a list of events for the authenticated workspace. The list will be paginated and the provided query parameters allow filtering the returned events.