Links

Search Links (POST)

Search for links with advanced filtering via POST body. Useful when filter parameters are too complex for query strings.

Requires: Authenticated user with workspace access.

Authorization:

post/links/search

Request

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

Headers

Workspacestring
Example:workspace123abc

Workspace public ID

apikeystring required

API key for authentication

Request body

termstring

Search term (matches destination, slashtag, title)

limitinteger

Maximum results to return

laststring

Cursor for pagination

Response

Search results

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.