Search
Search finds records across a workspace in one ranked list: tasks, features, bug reports, feature requests, sessions, applications and sandboxes. Search by an ID such as TASK-12 to find that record, by a bare number to match it across every kind of record, or by any other text to match titles. Results include only the kinds of records you can read.
Find records across types by display id or title
One ranked list across tasks, features, bug reports, feature requests, coding sessions, applications and sandboxes. THE way to resolve a display id the user typed (TASK-12, BUG-3, FEAT-7, COMP-4, SSID-9, PFR-2, APP-1, SBX-2) to its record and uuid: pass it as q and the exact match comes first. A bare number matches that display id across every type. Any other text searches titles across every type (it does not search descriptions; use search-features or search-feature-requests for that). Each hit carries entityType, entityId (the uuid the get-* tools take), displayId, title, and the sub-type needed to name it (feature kind, taskType, sessionCategory). Only the types the calling user may read are returned. People, teams and companies are not covered: find a contact with list-contacts, an account with list-accounts, a member of your organization with list-assignable-users and a team with list-teams.
path Parameters
workspaceIdWorkspace UUID
query Parameters
qWhat to find. A display id such as TASK-12, BUG-3, FEAT-7 or SBX-2 resolves that exact record (and TASK-1 lists TASK-1, TASK-10, TASK-11 ...); a bare number matches that display id across every type; any other text searches titles across every type. Empty lists the most recently updated records.
typesComma-separated subset of: task, feature, bug_report, feature_request, session, application, sandbox. Omit for all of them. A display-id prefix in q already pins the type.
limitMaximum hits, ranked. Default 20, at most 50.
Find records across types by display id or title › Responses
Ranked hits, best first
Resolve a display number to a record id
The record of one type that carries this number in this workspace: 62 for TASK-62, 43 for FEAT-43 or COMP-43. Numbers are per workspace, so the same number names a different record in each one. Returns the record's id, which every by-id endpoint takes. 404 when no record of that type has the number here; 403 when you may not read that type.
path Parameters
workspaceIdWorkspace UUID
entityTypeWhat kind of record the number belongs to: task, feature, feature_request, bug_report, session, release, application, sandbox or knowledge_base_document.
displayIdThe record's number in this workspace, without its prefix: 62 for TASK-62, 43 for FEAT-43 or COMP-43.
Resolve a display number to a record id › Responses
The record the number names