Developers API reference Version 1 · generated from the code openapi.json
Routes

search

Search

GET /api/v1/search

Search the names of binders and flows and the titles and text of steps, across everything the account can open.

At most 50 results per kind; truncated says there were more.

Required scope: read

Query parameters

  • q string · required

    What to look for, 2 to 200 characters.

  • types array of string · optional

    Restrict the search to some kinds of match: binder, flow, step_title, step_text. Repeat the parameter for several.

Response

200 SearchResults

  • query string

    The query, as it was understood.

  • truncated boolean

    Whether there were more results than the 50 per kind returned.

  • binders array of SearchBinder

    The binders whose name matches.

    5 fields
    • id integer

      Id of the binder or flow.

    • name string

      Its name.

    • path array of string

      The names of what holds it, from the space down.

    • level string

      What the account may do with it.

    • closed boolean

      Whether the account, a reader of it, finds it offline and cannot open it.

  • flows array of SearchFlow

    The flows whose name or steps match.

    7 fields
    • id integer

      Id of the binder or flow.

    • name string

      Its name.

    • path array of string

      The names of what holds it, from the space down.

    • level string

      What the account may do with it.

    • closed boolean

      Whether the account, a reader of it, finds it offline and cannot open it.

    • name_matched boolean

      Whether the query was found in the name of the flow itself, and not only in its steps.

    • steps array of SearchStep

      The steps of the flow that match.

      6 fields
      • id integer

        Id of the step.

      • reference string

        Its reference.

      • version string

        The version of the flow the step belongs to.

      • matched string

        Where the query was found.

      • title string

        Its title; empty for a reader when the author hid it.

      • excerpt string

        The text around the match, as plain text.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt