ListFamilyCandidateRuns
Lists runs that match a candidate-run CEL filter. Supports include_archived as a CEL directive (archived runs are excluded by default; pass include_archived == true in the filter to include them). When family_id is provided, runs already on that family’s persisted membership (both included and excluded) are filtered out so the response only contains runs not yet on the family.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided must match the call that provided the page token.
A Common Expression Language (CEL) filter string.
Supports all ListRuns filter fields plus include_archived.
When include_archived is not present in the filter, archived runs are excluded by default.
Set include_archived == true in the filter to include archived runs.
Note: include_archived is a directive and must appear at the top level of the filter
(or within a top-level AND chain). It cannot be used inside an OR expression.
How to order the retrieved runs. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
Available fields to order_by are name, description, created_date, modified_date, start_time, and stop_time.
If left empty, items are ordered by created_date in descending order (newest-first).
Optional family ID to filter out runs already on the family's persisted membership. When set, the response excludes runs that are already included or excluded in the family. Omit this field when working with draft membership changes.