GET
/
links
Go
package main

import(
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := dubgo.New(
        dubgo.WithSecurity("DUB_API_KEY"),
    )

    res, err := s.Links.List(ctx, operations.GetLinksRequest{
        ShowArchived: dubgo.Bool(false),
        WithTags: dubgo.Bool(true),
        PageSize: dubgo.Float64(50),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}
[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "url": "<string>",
    "trackConversion": false,
    "externalId": "<string>",
    "tenantId": "<string>",
    "programId": "<string>",
    "partnerId": "<string>",
    "archived": false,
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "password": "<string>",
    "proxy": false,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "video": "<string>",
    "rewrite": false,
    "doIndex": false,
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "publicStats": false,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "red"
      }
    ],
    "folderId": "<string>",
    "webhookIds": [
      "<string>"
    ],
    "comments": "<string>",
    "shortLink": "<string>",
    "qrCode": "<string>",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "testVariants": [
      {
        "url": "https://example.com/variant-1",
        "percentage": 50
      },
      {
        "url": "https://example.com/variant-2",
        "percentage": 50
      }
    ],
    "testStartedAt": "<string>",
    "testCompletedAt": "<string>",
    "userId": "<string>",
    "workspaceId": "<string>",
    "clicks": 0,
    "leads": 0,
    "conversions": 0,
    "sales": 0,
    "saleAmount": 0,
    "lastClicked": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "tagId": "<string>",
    "projectId": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

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

​
tagNames

The unique name of the tags assigned to the short link (case insensitive).

​
folderId
string

The folder ID 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.

​
tenantId
string

The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.

​
showArchived
boolean
default:false

Whether to include archived links in the response. Defaults to false if not provided.

​
withTags
boolean
default:false
deprecated

DEPRECATED. Filter for links that have at least one tag assigned to them.

​
sortBy
enum<string>
default:createdAt

The field to sort the links by. The default is createdAt.

Available options:
createdAt,
clicks,
saleAmount,
lastClicked
​
sortOrder
enum<string>
default:desc

The sort order. The default is desc.

Available options:
asc,
desc
​
sort
enum<string>
default:createdAt
deprecated

DEPRECATED. Use sortBy instead.

Available options:
createdAt,
clicks,
saleAmount,
lastClicked
​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:100

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

200
application/json

A list of links

The response is of type Link · object[].