API Reference

scenario-search

post
https://example.com/api/v3/search/scenarios//query
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Either userId or zoeId must be provided to scope the search.

string
required

Free-text query to search for across supported fields.

integer
required
≥ 0

Zero-based page index.

integer
required
≥ 1

Number of items per page.

filters
array

Optional list of filters applied with AND semantics. null is treated as an empty list.

Filters
ScenarioSearchSortFDTO | null

Optional sort specification.

includeFields
array of strings

Optional whitelist of fields to include in each item. Use * to return all fields, which can be helpful for exploring available fields. null is treated as an empty list.

Includefields

Optional logged-in user identifier to scope the search. Either userId or zoeId must be provided.

Optional anonymous user identifier to scope the search. The field name zoeId is retained for API compatibility. Either userId or zoeId must be provided.

Responses

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago