Search

Search across all entity types within the authenticated organization.

Applies ilike substring matching on name fields and Postgres prefix tsquery (to_tsquery with :*) FTS on free-form text fields (description, notes).

Parameters

q : str Search query, minimum 2 characters. limit : int Maximum number of results to return in this page (1–100). offset : int Number of results to skip before this page. per_type : int Maximum results to return per entity type (1–20). Defaults to 5. entity_types : list[str] | None When provided, restrict results to these entity type strings. Omit to search all types. project_id : str | None When set, scope project-scoped entities (pipelines, optimizations, studies) to this project. Org-scoped entities are unaffected.

Returns

SearchResponse Paginated results from matching entity types with total count.

get/search

Query parameters

qstring required

Search query (minimum 2 characters)

Search query (minimum 2 characters)

limitinteger

Maximum results to return in this page

Maximum results to return in this page

offsetinteger

Number of results to skip before this page

Number of results to skip before this page

per_typeinteger

Maximum results to return per entity type (1–20).

Maximum results to return per entity type (1–20).

entity_typesstring[] nullable

Restrict to these entity type strings (repeatable). Omit to search all types.

Restrict to these entity type strings (repeatable). Omit to search all types.

project_idstring nullable

When set, scope project-scoped entities to this project.

When set, scope project-scoped entities to this project.

Response

Successful Response

querystring required
totalinteger required
limitinteger required
offsetinteger required

Changes