GET
/
links
curl --request GET \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "url": "<string>",
    "archived": false,
    "expiresAt": "<string>",
    "password": "<string>",
    "proxy": false,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "rewrite": false,
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "publicStats": false,
    "tagId": "<string>",
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "red"
      }
    ],
    "comments": "<string>",
    "shortLink": "<string>",
    "qrCode": "<string>",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "userId": "<string>",
    "workspaceId": "<string>",
    "clicks": 0,
    "lastClicked": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "projectId": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
workspaceId
string
required

The ID of the workspace the link belongs to.

​
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

[DEPRECATED] (use tagIds instead): The tag ID to filter the links by.

​
tagIds

The tag IDs to filter the links by.

​
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
number

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

Response

200
application/json

A list of links

The response is of type object[].