Search Docs

Search Docs lets you search Docs by title, with optional archived/created_by_me/followed_by_me filters.

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

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/documents/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

Search text to match against Doc titles. Supports fuzzy matching. Required if cursor is not sent.

archivedboolean

When true, find archived Docs. When false, find non-archived Docs.

created_by_meboolean

When true, find Docs created by the current user. When false, find Docs NOT created by the current user.

followed_by_meboolean

When true, find Docs that the current user is following. When false, find Docs NOT followed by the current user.

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

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.