Skip to main content
GET
Search Workspace

Authorizations

Authorization
string
header
required

A token from the identity provider your deployment federates with. It identifies a person; their roles in the workspace decide what they may do.

Query Parameters

q
string
default:""

free text, or a pasted identifier

per_kind
integer
default:5
Required range: 1 <= x <= 25

Response

Successful Response

query
string
required
exact
HitOut · object | null

One thing found, and what it is.

hits
HitOut · object[]
counts
Counts · object
total
integer
default:0
shown
integer
default:0