Sign in
Search

Cross-entity workspace search

Changed on

Bearer atc:read (or cookie session). Searches ATCs, Tests, Projects, Modules, Bugs and Runs inside ONE workspace and returns up to 5 matches per entity type, each with a ready-to-navigate href.

There is deliberately no workspace path segment and no workspace query parameter — the caller is never the authority on scope. A cookie session is scoped to its active workspace (the bk_active_ws cookie, falling back to the caller's oldest workspace); a Bearer PAT is scoped to the workspace it was issued against.

Scope failures never disclose existence: an unknown, foreign or inaccessible workspace and a query with no matches all return the same 200 { "data": [], "truncated": false }. This route answers no 403 or 404 for scope reasons.

get/api/v1/search

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/search
  • Auth: one of:
    • API key in cookie sb-fmbpikzpkafptqximhxn-auth-token
    • HTTP bearer

Query parameters

qstring required

Required. Free-text query, trimmed server-side; it must be at least 2 characters AFTER trimming, so " a " fails with 422. The client is expected never to send a shorter query in the first place — this is a defensive backstop.

limitinteger

1..20, default 20. A per-request ceiling only: the underlying RPC independently caps each entity group at 5 rows, so raising limit never returns more than 5 of any one type.

Response

Matches, grouped-capped and possibly empty.

truncatedboolean required

True when ANY entity group hit its 5-row cap — the signal for rendering a per-group "+ more" hint. It does not mean the whole result set was cut to limit.

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status