v1

latestOpenAPI 3.0.32026-07-24311635.6 KB
Links

/v1/links

Get a list of links

get/v1/links

Query parameters

domain.idstring

Filter branded short links which refer to a specific branded domain id (or specify a comma-separated set of ids)

domain.fullNamestring

Filter branded short links which refer to a specific branded domain's name (FQDN)

slashtagstring

Filter branded short links according to their slashtag value. Use in conjunction with domain.id or domain.fullName parameter to get a specific link. WARNING: this will not take effect if you don't specify also a domain.id or a domain.fullName along with the request

creator.idstring

Filter branded short links which have been created by a specific teammate id (or specify a comma-separated set of ids)

dateFromstring

Filter branded short links according to the date they have been created, so as to exclude links created before this date. Format is YYYY-MM-DD.

dateTostring

Filter branded short links according to the date they have been created, so as to exclude links created after this date. Format is YYYY-MM-DD.

orderBystring

Sorting criteria to apply to your branded short links collection among createdAt, updatedAt.

orderDirstring

Sorting direction to apply to your branded short links collection

limitinteger

How many branded short links to load (max: 25)

laststring

The id of the last link you fetched, see Infinite Scrolling section

Headers

workspacestring

Which workspace id to filter links by. No workspace specified will select default workspace (if any).

Response

200

idstring
titlestring
slashtagstring
destinationstring
createdAtstring
updatedAtstring
shortUrlstring

Example response

[
  {
    "id": "fffa4cc5b6ee45d6g7897b06ac2d16af",
    "title": "What is Rebrandly",
    "slashtag": "video",
    "destination": "https://www.youtube.com/watch?v=3VmtibKpmXI",
    "createdAt": "2016-07-13T10:54:12.000Z",
    "updatedAt": "2016-07-13T10:54:12.000Z",
    "shortUrl": "rebrand.ly/video",
    "domain": {
      "id": "8f104cc5b6ee4a4ba7897b06ac2ddcfb",
      "fullName": "rebrand.ly"
    }
  }
]
All 31 operations