Search

Searching in Clubhouse: Story Search

You can use the Search page to find Stories using the search operators below.

Searching_in_Clubhouse_on_the_Search_Page.png

You can also use the Navigational Search Bar from any page in Clubhouse to find Stories using search operators. Also, as you type, our search will auto-suggest any operators that might match your query. Results can be found under the Stories tab in the Navigational Search Bar.

The_Navigational_Search_Bar__Stories_View_.png

In both places, search results are listed in order of relevance (custom sorting isn't available at this time).

Story search queries will look for matches in Story titles, descriptions, and comments, and by default all queries will use AND logic when combining multiple operators (OR logic is not available in Search at this time, but it is available when filtering on the Stories page).

There are two categories of search operators available when searching for Stories: Story-specific search operators (which will find results only for Stories), and general search operators (which will find results for both Stories and Epics).

Story-Specific Search Operators

type:

Finds all Stories of a specific type (feature, bug, or chore). A query that contains more than one unique type operator will yield no results.

estimate:

Finds all Stories of a specific point value. This is a numeric value, i.e. estimate:4. See our Estimate Scale article for more information about point estimations.

has:attachment

Finds all Stories with attachments. This operator only searches for attached files, not anything pasted or uploaded in comments.

has:task

Finds all Stories with tasks.

has:epic Finds all Stories added to an Epic.
is:blocked

Finds all Stories that have been marked using Story Relationships as blocked by another Story

is:blocker

Finds all Stories that have been marked using Story Relationships as blocking another Story.

is:story Returns only Stories in search results.General Search Operators

 

General Search Operators

ID Number
Project
Epic
Milestone
Workflow State Operators
Label
Owner
Requester
Inversions and Exclusions
Dates and Date Ranges 
The `has:` Operators
The `is` Operators

ID Number

Finds a Story by its ID number.

id:135

Search by Story ID

The following operators match text -- they can be single words that contain no spaces, or quoted strings that may contain spaces. 

Project

Finds Stories in a specific Project (may use the Project name or Project ID). For best results, queries for multi-word Project titles should be placed in double quotes.

project:frontend

Find_Stories_by_Project_in_Clubhouse.png

Epic

Finds all Stories in a specific Epic. For best results, queries looking for an exact match should be placed in double quotes.

epic:"all your epics are belong to us"

Search by Epic

Milestone

Find all Stories in the Epics within a specific Milestone. For best results, queries for multi-word Milestone titles should be placed in double quotes.

Search_for_Stories_in_a_Milestone_in_Clubhouse.png

Workflow State Operators

Finds all Stories in a specific Story workflow state. For best results, queries for multi-word workflow state titles should be placed in double quotes.

state:"ready for dev"

Searching_for_Stories_by_Workflow_State.png

The state: operator can be used with either a Workflow Name (as in the above example) or a Workflow ID. 

If you use the Workflow ID, note that it is Team-specific, meaning it will return results only for Stories in a specific team (even if the text-based State name, ex. Unscheduled, is the same across Teams).

In the example below, 500000016 is the Workflow ID for the Unscheduled State in one Team in this Workspace.

If you use the Workflow Name with the operator, state:Unscheduled, it will search across Teams based on the text of the name. You can see that in addition to the search results returned using 500000016, using the name Unscheduled returns results from all Teams in the Workspace. 

Searching across Workflow States

In addition to the state: operator, the following operators search over the different types of workflow states.

Since stories can only have one workflow state, using more than one of these operators can yield no results.

  • is:unstarted
  • is:started
  • is:done

Label

Finds all Stories with a specific Story label. For best results, queries for multi-word labels should be placed in double quotes.

label:"user feedback"

Search_for_Stories_by_Label_in_Clubhouse.png

Note: At this time, Stories do not inherit Epic labels. In this example, there are two Epics returned by this search because there is an Epic label also named 'user feedback.'

Owner

Finds all Stories owned by a user. This query requires the user's full mention name (also known as their @-name) to work. Do not include the @ symbol at the beginning of the mention name.

owner:stephlundberg

Search by Owner

Requester

Finds all Stories requested by a user. This query requires the user's full mention name (also known as their @-name) to work. Do not include the @ symbol at the beginning of the mention name.

requester:stephlundberg

Inversions and Exclusions

Of note, you can search for the inverse or exclude an operator by adding an ! or - in front of the operator. This is equivalent to a NOT boolean operator.

For example, i.e. !has:comment and -has:comment will return Stories with no comments.

Search for Stories without Comments

Dates and Date Ranges

First, it's important to use the correct date formatting in your searches. The format Clubhouse recognizes is 4 digit year-2 digit month-2 digit day:

YYYY-MM-DD

When searching for a date range, separate your dates with two periods:

YYYY-MM-DD..YYYY-MM-DD

You can make your date range open-ended (or unbounded, in search parlance) by adding an asterisk (*) on one side of the range. 

An asterisk on the left side of the date range would find you all Stories before the specified date:

*..YYYY-MM-DD

And an asterisk on the right side of the date range would find you all Stories after the specified date: 

YYYY-MM-DD..*

You can also search using the terms yesterday and today, as well as tomorrow (but this latter term can only be used when searching for due dates, more on this below).

Please note that numerical date values and date terms currently can't be mixed -- so a search for '2018-04-01..today' wouldn't work, for example.

Date-Based Operators

You can search for Stories that have been created, updated, completed, or moved using a specified date or date range, or the terms yesterday or today.

You can also search for Stories that are (or were) due on a specified date or date range, or using the terms yesterday, today, or tomorrow.

Examples:

created:2018-05-22

Search_for_Stories_Created_on_a_Specified_Date.png

  updated:today  

Note: The updated operator will find Stories that have had changes or additions made to it on or within the specific time period (i.e., changes in description, comments, state, due date, Project, Epic, etc.).

Note: When using the updated: operator, keep in mind that it asks "What Stories or Epics were last updated on/before/after this date or within this date range?"

Search_for_Stories_Updated_Today.png

moved:*..2016-11-17

Note: The moved operator will only find Stories that have changed workflow state (i.e., those which have "moved" to a different workflow state column) on or within a specified time period.

Search_for_Stories_Moved_Using_an_Unbounded_Date_Range.png

completed:2018-04-01..2018-05-22

Searching_for_Stories_Completed_in_a_Date_Range.png

due:tomorrow

Searching_for_Stories_Due_Tomorrow.png

The `has:` Operators

  • has:comment - Finds all Stories with comments.
  • has:label - Finds all Stories with a label.
  • has:deadline - Finds all Stories with a due date.
  • has:owner - Finds all Stories with an owner.

The `is` Operators

  • is:unestimated - Finds all Stories with a point value of 0 (in other words, Stories with no point estimation).
  • is:overdue - Finds all Stories with a due date in the past.
  • is:archived - Finds all archived Stories.
Have more questions? Submit a request
Powered by Zendesk