Close menu
Explore Plans
Mobile menu Close menu
Back
Shortcut

Find a story

Pro plus icon Search your Shortcut workspace for stories. Supports Shortcut's search operators (e.g. state:, type:, owner:, label:, epic:) in addition to plain keywords.

Developer info

API endpoint slug
shortcut.find_a_story
Runtime method
performQuery("shortcut.find_a_story"}

Query fields

Query Text input > Other

Label
Search query
Helper text
Keywords and/or Shortcut search operators. Examples: login bug, type:bug state:"In Progress", owner:jake.
Slug
query
Required
true
Can have default value
true

Ingredients

Story The unique identifier for the story in Shortcut.

Slug
story_id
Filter code
Shortcut.findAStory.StoryId
Type
String
Example
12345

Story name The title or name of the story.

Slug
story_name
Filter code
Shortcut.findAStory.StoryName
Type
String
Example
Implement new login flow

Story url The direct URL to view the story in the Shortcut web application.

Slug
story_url
Filter code
Shortcut.findAStory.StoryUrl
Type
Web URL
Example
https://app.shortcut.com/myworkspace/story/12345

Story description The detailed description of the story requirements and specifications.

Slug
story_description
Filter code
Shortcut.findAStory.StoryDescription
Type
String
Example
Detailed description of the new login flow requirements.

Story type The type of work represented by this story.

Slug
story_type
Filter code
Shortcut.findAStory.StoryType
Type
String
Example
Feature

Created at The timestamp when the story was originally created.

Slug
created_at
Filter code
Shortcut.findAStory.CreatedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Updated at The timestamp when the story was last modified.

Slug
updated_at
Filter code
Shortcut.findAStory.UpdatedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Completed at The timestamp when the story was marked as completed.

Slug
completed_at
Filter code
Shortcut.findAStory.CompletedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Requested by The unique identifier of the team member who requested this story.

Slug
requested_by_id
Filter code
Shortcut.findAStory.RequestedById
Type
String
Example
a1b2c3d4-e5f6-7890-1234-567890abcdef

Owner ids Comma-separated list of team member identifiers assigned to work on this story.

Slug
owner_ids
Filter code
Shortcut.findAStory.OwnerIds
Type
String
Example
a1b2c3d4-e5f6-7890-1234-567890abcdef,b2c3d4e5-f6a7-8901-2345-67890abcdef0

Estimate The story point estimate representing the complexity or effort required.

Slug
estimate
Filter code
Shortcut.findAStory.Estimate
Type
String
Example
5

Comment ids Comma-separated list of comment identifiers associated with this story.

Slug
comment_ids
Filter code
Shortcut.findAStory.CommentIds
Type
String
Example
5678,9012,3456

Workflow The unique identifier of the workflow that governs this story's states.

Slug
workflow_id
Filter code
Shortcut.findAStory.WorkflowId
Type
String
Example
500000011

Workflow name The name of the workflow that governs this story's states.

Slug
workflow_name
Filter code
Shortcut.findAStory.WorkflowName
Type
String
Example
Development Workflow

Workflow state The unique identifier of the current workflow state for this story.

Slug
workflow_state_id
Filter code
Shortcut.findAStory.WorkflowStateId
Type
String
Example
500000011

Workflow state name The name of the current workflow state for this story.

Slug
workflow_state_name
Filter code
Shortcut.findAStory.WorkflowStateName
Type
String
Example
In Review

Team The unique identifier of the team responsible for this story.

Slug
team_id
Filter code
Shortcut.findAStory.TeamId
Type
String
Example
z9y8x7w6-v5u4-3210-fedc-ba9876543210

Team name The name of the team assigned to this story.

Slug
team_name
Filter code
Shortcut.findAStory.TeamName
Type
String
Example
Backend Developers

Epic The unique identifier of the epic that contains this story.

Slug
epic_id
Filter code
Shortcut.findAStory.EpicId
Type
String
Example
123

Epic name The name of the epic that contains this story.

Slug
epic_name
Filter code
Shortcut.findAStory.EpicName
Type
String
Example
User Feedback Epic

Iteration The unique identifier of the sprint or iteration containing this story.

Slug
iteration_id
Filter code
Shortcut.findAStory.IterationId
Type
String
Example
101

Iteration name The name of the sprint or iteration containing this story.

Slug
iteration_name
Filter code
Shortcut.findAStory.IterationName
Type
String
Example
Sprint 23 - User Feedback

Iteration start date The date when the iteration begins.

Slug
iteration_start_date
Filter code
Shortcut.findAStory.IterationStartDate
Type
Date (ISO8601)
Example
2020-07-07

Iteration end date The date when the iteration is scheduled to end.

Slug
iteration_end_date
Filter code
Shortcut.findAStory.IterationEndDate
Type
Date (ISO8601)
Example
2020-07-07

Iteration status The current status of the iteration containing this story.

Slug
iteration_status
Filter code
Shortcut.findAStory.IterationStatus
Type
String
Example
Started

File urls Comma-separated list of file URLs attached to this story.

Slug
file_urls
Filter code
Shortcut.findAStory.FileUrls
Type
String
Example
url1,url2,url3

Task descriptions Comma-separated list of task descriptions associated with this story.

Slug
task_descriptions
Filter code
Shortcut.findAStory.TaskDescriptions
Type
String
Example
task1,task2,task3

Blocked Whether this story is currently blocked by other stories.

Slug
blocked
Filter code
Shortcut.findAStory.Blocked
Type
String
Example
true

Blocker Whether this story is blocking other stories from proceeding.

Slug
blocker
Filter code
Shortcut.findAStory.Blocker
Type
String
Example
false