Search

Search

Search links and domains in the workspace.

get/search

Request

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

Query parameters

termstring

Search term

linksLimitinteger
domainsLimitinteger
mode'strict' | 'flexible'

Headers

Workspacestring
Example:workspace123abc

Workspace public ID

apikeystring required

API key for authentication

Response

Search results

Example response

{
  "links": [
    {
      "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
    }
  ],
  "domains": [
    {
      "fullName": "rebrand.ly",
      "topLevelDomain": "ly"
    }
  ]
}

Changes

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