Quick search across workspace entities

Performs a unified search across multiple workspace entity types in a single query. This endpoint searches through tasks, projects, employees, organizations, organization members, teams, contacts, and the workspace itself. The search matches the query term against entity names, titles, and other searchable fields. Results are automatically filtered based on user permissions and workspace scoping, ensuring users only see entities they have access to. Each result includes the entity type, title, metadata (including ID), color, icon, and short name (if applicable). This endpoint is commonly used for command palettes, global search functionality, and entity pickers that need to search across multiple types. The search is case-insensitive and performs partial matching on entity names and titles.

GET/workspace/quick-search

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

termstringrequired

Search term to match against entity names, titles, and other searchable fields. The search is case-insensitive and performs partial matching. Can be a single word or multiple words. Examples: "project", "John Smith", "Acme Corp".

Responses

200

Search results matching the query term

Array of QuickSearchResultDto

colorstring

Color associated with the entity, typically in HEX format (e.g., "#ff0000"). Used for visual identification in lists, kanban boards, and other UI components. May be null if the entity type does not support colors.

iconobject | null

Icon identifier for the entity, typically a FontAwesome icon class name (e.g., "faSquare", "faUser"). Used for visual representation in UI components. May be null if no icon is set for the entity.

metaobjectrequired

Entity metadata object containing the entity ID and additional type-specific fields. The id field is always present and can be used to fetch full entity details. Other fields vary by entity type (e.g., projectId for tasks, organizationId for projects).

shortNameobject | null

Short name or code for the entity, often used for quick identification (e.g., "ORG-001", "PRJ-123"). This is a human-readable identifier that may be displayed alongside the title. May be null if the entity type does not use short names.

titlestringrequired

Display title or name of the entity. This is the primary text shown in search results and is what the search term matched against.

typestringrequired

Type of entity that was found. Indicates which kind of workspace resource this result represents. Use this to determine how to handle or display the result in your application.

Allowed:employeeorganizationorganizationMemberworkspaceprojecttaskteamcontact

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

termquery*Search term to match against entity names, titles, and other searchable fields. The search is case-insensitive and performs partial matching. Can be a single word or multiple words. Examples: "project", "John Smith", "Acme Corp".

Request

curl -X GET "https://leadtime.app/api/public/workspace/quick-search?term=project" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/workspace/quick-search?term=project", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/workspace/quick-search?term=project",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "color": "#ff0000",
    "icon": "faSquare",
    "meta": {
      "id": "uuid",
      "organizationId": "uuid",
      "projectId": "uuid"
    },
    "shortName": "ORG-001",
    "title": "Project Alpha",
    "type": "project"
  }
]