Skip to navigation

Search

Everything in one app that matches q, grouped by kind: what the app’s top bar search shows. Matching is the list endpoints’ q (every word in some field, case and accents ignored, at most 100 characters and 8 words; see Searching under Errors and pagination), and each group finds only what its list would show the caller: a signed-in person never finds a private objective they may not see, an event they may not run, a question on one, or a draft link’s destination they may not edit. A key speaks for the workspace.

Each group needs its list’s read scope (see SearchGroupType); the groups the caller cannot read are left out, and a caller who can read none of the app’s is refused with 403 insufficient_scope, naming the scopes in details.scopes. A signed-in person needs a seat on the app (403 seat_required). Each group counts every match and returns the first five.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

appenumRequired

The app to search. Missing or unknown, 400 invalid_app.

Allowed values:
qstringOptional

What to find. Every word must appear in one of a thing’s fields; case and accents are ignored; at most 100 characters and 8 words. Left out or blank, every group comes back empty.

Response

This endpoint returns an object.
appenum
The app to search, by its slug.
Allowed values:
querystring
The query as searched, trimmed and cut to 100 characters.
groupslist of objects

The app’s groups, in order, each the caller’s scopes can read. A group with nothing in it is still listed, with total 0.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Subscription Required Error
403
Forbidden Error
429
Too Many Requests Error