GET/api/v1/search

Search everything

Fuzzy search over everything you can open: titles, headings, the text of pages and documents, the text of HTML files and PDFs, folders, workspaces, the Guides pages you have a role on and, at the end, your Trash. Typos, partial words and any word order match. items is the ranked page of results; groups holds the first few of each kind, for a grouped list; trash lists matching items you can restore. Each result has its kind, title, workspace, folder, owner (named only when you're related to the item), updated_at, a snippet with the matched words' ranges in marks, match (title, heading or body), url (what the app opens) and web_url (always a full link). Encrypted and password-protected items match by title only and never have a snippet. Pass next_cursor back as cursor for more. ai_suggested is true when q reads like a question.

API token required240 per minute per IPMCP: searchCLI: markdrop search

Guide: Search

Code samples and Try it

Query parameters

#
  • qstring

    What to look for. Up to 200 characters. Default "".

  • scopestring

    all (the default) or workspace:<workspace id> for one workspace. Up to 40 characters.

  • kindstring

    Comma-separated kinds: page, doc, file, folder, workspace, guide. Up to 80 characters.

  • ownerstring

    me keeps only your own items. One of anyone, me. One of anyone, me. Default "anyone".

  • updatedstring

    week or month keeps only what changed in that time. One of any, week, month. One of any, week, month. Default "any".

  • currentstring

    The id of the workspace you're in: its items rank a little higher. Up to 40 characters.

  • cursorstring

    The next_cursor of the previous answer. Up to 200 characters.

  • limitinteger

    Results per answer, up to 50. From 1 to 50. Default 20.

  • trashboolean

    false leaves out the Trash matches. Default true.

Responses

#
  • 200OK.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?