GET
/
partners
/
links
import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.partners.retrieveLinks({
    programId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();
[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "shortLink": "<string>",
    "url": "<string>",
    "clicks": 0,
    "leads": 0,
    "sales": 0,
    "saleAmount": 0
  }
]

Partners endpoints require an Advanced plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
programId
string
required
​
partnerId
string
​
tenantId
string

Response

200
application/json
The retrieved partner links.

The response is of type object[].