Suggested Searches — GET /api/v1/search/suggested
Suggested Searches
What the /search page offers while its box is empty, for one project.
Endpoint: GET /api/v1/search/suggested
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | query | yes | string | The ONE project the suggestions are for | |
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | SearchSuggestionsResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
400, with the message “Invalid project ID”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Search
- Operation ID:
suggested_searches_api_v1_search_suggested_get - Source code:
backend/app/routers/search.py, line 910 - Specification: OpenAPI JSON