List links with the Dub API

Lists the short links of the workspace with destination, tags, folder, UTM parameters and the counts of clicks, leads and sales. For the next page, send the id of the last link as startingAfter; a page shorter than pageSize is the last one.

Identifier
dub_list_links

The request

POST https://connect.reportei.com/api/tools/dub_list_links/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "search": "<search>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
searchstringNoText matched against the short link slug and the destination URL.
domainstringNoOnly links of this domain, such as dub.sh or a custom domain from List domains.
tagIdsstringNoOnly links with these tags: ids from List tags, separated by commas.
folderIdstringNoOnly links in this folder. Id from List folders.
showArchivedbooleanNotrue also returns archived links.
pageSizeintegerNoLinks per page, up to 100. The default is 100.
startingAfterstringNoId of the last link of the previous page, from List links.

Supported connections

Your customer connects their Dub account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/dub, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/dub_list_links. It becomes your agent's tool definition with no conversion.

Other Dub tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.