---
updatedAt: 2026-06-22T06:24:00.000Z
agentTools:
  projectIndex: https://developers.rebrandly.com/llms.txt
---

# Search

Search links and domains in the workspace.

# OpenAPI definition

````json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Rebrandly API",
    "description": "# Rebrandly API Documentation\n\nThe Rebrandly API allows you to programmatically create, update, and manage your branded short links,\ncustom domains, workspaces, and analytics.\n\n## Base URL\n\nAll API requests should be made to:\n```\nhttps://api.rebrandly.com/v1\n```\n\n## Authentication\n\nThe Rebrandly API uses API keys for authentication. You can obtain your API key from your\n[Rebrandly account settings](https://app.rebrandly.com/account/api-keys).\n\nInclude your API key in the request header:\n```\napikey: YOUR_API_KEY\n```\n\n## Rate Limiting\n\nAPI requests are rate-limited based on your subscription plan. Rate limit information is included\nin response headers:\n- `X-RateLimit-Limit`: Total requests allowed per period\n- `X-RateLimit-Remaining`: Requests remaining in current period\n- `X-RateLimit-Reset`: Time when the rate limit resets (Unix timestamp)\n\n## Multi-Tenancy and Workspaces\n\nMost Rebrandly API resources (links, domains, scripts, tags) are organized into **Workspaces**.\nTo access resources in a specific workspace, you must include the `Workspace` header with the workspace's unique ID.\n\n```\nWorkspace: YOUR_WORKSPACE_ID\n```\n\nIf the `Workspace` header is omitted, the request will be processed in your **Default Workspace**.\n",
    "version": "7.0.2",
    "contact": {
      "name": "Rebrandly Team",
      "email": "dev@rebrandly.com"
    },
    "license": {
      "name": "Proprietary"
    }
  },
  "servers": [
    {
      "url": "https://api.rebrandly.com/v1",
      "description": "Production API"
    }
  ],
  "paths": {
    "/search": {
      "get": {
        "summary": "Search",
        "description": "Search links and domains in the workspace.",
        "operationId": "search",
        "parameters": [
          {
            "$ref": "#/components/parameters/WorkspaceHeader"
          },
          {
            "$ref": "#/components/parameters/ApiKeyHeader"
          },
          {
            "$ref": "#/components/parameters/TermParam"
          },
          {
            "name": "linksLimit",
            "in": "query",
            "schema": {
              "type": "integer",
              "maximum": 25,
              "default": 25
            }
          },
          {
            "name": "domainsLimit",
            "in": "query",
            "schema": {
              "type": "integer",
              "maximum": 25,
              "default": 25
            }
          },
          {
            "name": "mode",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "strict",
                "flexible"
              ],
              "default": "strict"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "links": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Link"
                      }
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Domain"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "Search"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Search",
      "description": "Search across links and domains."
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "apikey",
        "description": "Rebrandly API key for authentication"
      }
    },
    "parameters": {
      "WorkspaceHeader": {
        "name": "Workspace",
        "in": "header",
        "required": false,
        "description": "Workspace public ID",
        "schema": {
          "type": "string",
          "example": "workspace123abc"
        }
      },
      "ApiKeyHeader": {
        "name": "apikey",
        "in": "header",
        "required": true,
        "description": "API key for authentication",
        "schema": {
          "type": "string"
        }
      },
      "TermParam": {
        "name": "term",
        "in": "query",
        "description": "Search term",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "Link": {
        "type": "object",
        "required": [
          "id",
          "slashtag",
          "destination",
          "shortUrl",
          "createdAt",
          "updatedAt",
          "status"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Link public ID (link_public_id)",
            "example": "abc123def456"
          },
          "title": {
            "type": "string",
            "description": "Human-readable title for the link",
            "example": "My Example Link"
          },
          "slashtag": {
            "type": "string",
            "description": "URL path component",
            "example": "my-link"
          },
          "destination": {
            "type": "string",
            "format": "uri",
            "description": "Target URL where the link redirects",
            "example": "https://example.com"
          },
          "shortUrl": {
            "type": "string",
            "description": "Complete short URL (domain + slashtag)",
            "example": "rebrand.ly/my-link"
          },
          "domainId": {
            "type": "string",
            "description": "Public ID of the domain used",
            "example": "domain123abc"
          },
          "domainName": {
            "type": "string",
            "description": "Full domain name",
            "example": "rebrand.ly"
          },
          "domain": {
            "type": "object",
            "description": "Domain object with details",
            "properties": {
              "id": {
                "type": "string"
              },
              "ref": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "sharing": {
                "type": "object"
              }
            }
          },
          "clicks": {
            "type": "integer",
            "description": "Number of clicks on the link",
            "example": 0
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when link was created",
            "example": "2024-01-15T10:30:00.000Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when link was last updated",
            "example": "2024-01-15T10:30:00.000Z"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "deleted",
              "blocked"
            ],
            "description": "Link status",
            "example": "active"
          },
          "description": {
            "type": "string",
            "description": "Link description (only if links.notes feature is enabled)",
            "example": "This link redirects to our example page"
          },
          "workspace": {
            "type": "object",
            "description": "Workspace information",
            "properties": {
              "id": {
                "type": "string",
                "description": "Workspace public ID"
              }
            }
          },
          "https": {
            "type": "boolean",
            "description": "Whether the link supports HTTPS",
            "example": true
          }
        }
      },
      "Domain": {
        "type": "object",
        "required": [
          "id",
          "fullName"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Domain public ID"
          },
          "fullName": {
            "type": "string",
            "description": "Full domain name",
            "example": "rebrand.ly"
          },
          "topLevelDomain": {
            "type": "string",
            "description": "TLD",
            "example": "ly"
          },
          "type": {
            "type": "string",
            "enum": [
              "USER",
              "SYSTEM"
            ]
          },
          "status": {
            "type": "object",
            "properties": {
              "dns": {
                "type": "string",
                "enum": [
                  "verified",
                  "unverified",
                  "verifying"
                ]
              },
              "subscription": {
                "type": "string",
                "enum": [
                  "active",
                  "inactive",
                  "pending"
                ]
              }
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "x-readme": {}
}
````