Search

Search lets you search across Epics, Stories, Iterations, Objectives, and Docs with a single query, returning one combined, paginated list of results.

get/api/v4/{workspace-slug}/search

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/search
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

Query parameters

limitinteger

The number of results to include in a page. Can be between 1 and 100. Defaults to 10.

cursorstring

The cursor indicating where we are in a paged response. If sent, it (and an optional fields parameter) must be the only parameters.

querystring

The search query. Required if cursor is not sent. See our help center article on search operators.

entity_typesstring

A comma-separated list of entity types to search. Defaults to all supported types. Supported: epic, story, iteration, objective, doc. Docs are only included when the docs feature is enabled for the Workspace.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

current_itemsinteger required

The number of items on the current page.

current_pageinteger required

The number of the current page.

total_itemsinteger required

The number of total items across all pages.

total_pagesinteger required

The total number of pages.

next_page_urlstring

A URL to get the next page. Will be absent on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.