RErebrandly
Links

List Links

Retrieves a paginated list of links in the specified workspace.

Authorization: Requires authenticated user with workspace access.

get/links

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/links
  • Auth
    API key in header apikey

Query parameters

limitinteger

Maximum number of results (default 25, max 25)

orderBystring

Field to sort by

orderDir'asc' | 'desc'

Sort direction

laststring

Cursor for pagination (last item ID from previous page)

domain.idstring

Filter by domain ID

domain.fullNamestring

Filter by domain full name

slashtagstring

Filter by exact slashtag

creator.idstring

Filter by creator account ID

favouriteboolean

Filter by favourite status

status.activeboolean

Filter by active status

Headers

Workspacestring
Example:workspace123abc

Workspace public ID

apikeystring required

API key for authentication

Response

List of links

idstring required

Link public ID (link_public_id)

titlestring

Human-readable title for the link

slashtagstring required

URL path component

destinationstring uri required

Target URL where the link redirects

shortUrlstring required

Complete short URL (domain + slashtag)

domainIdstring

Public ID of the domain used

domainNamestring

Full domain name

clicksinteger

Number of clicks on the link

createdAtstring date-time required

Timestamp when link was created

updatedAtstring date-time required

Timestamp when link was last updated

status'active' | 'deleted' | 'blocked' required

Link status

descriptionstring

Link description (only if links.notes feature is enabled)

httpsboolean

Whether the link supports HTTPS

Example response

[
  {
    "id": "abc123def456",
    "title": "My Example Link",
    "slashtag": "my-link",
    "destination": "https://example.com",
    "shortUrl": "rebrand.ly/my-link",
    "domainId": "domain123abc",
    "domainName": "rebrand.ly",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "status": "active",
    "description": "This link redirects to our example page",
    "https": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.