v2

latestOpenAPI 3.1.02026-07-26143251806.6 KB
evaluations

List Evaluations

get/api/public/v2/evaluations

Query parameters

workspace_idinteger

Filter by specific workspace ID. If not provided, uses the current user's workspace

namestring

Filter evaluations by name (case-insensitive partial match)

status'active' | 'deleted' | 'all'

Filter evaluations by status: 'active' (default) returns only active evaluations, 'deleted' returns only deleted/archived evaluations, 'all' returns both

include_runsboolean

If true, include batch runs nested under each evaluation. Each run includes its full report data, status (RUNNING or COMPLETED), and cell status counts.

pageinteger

Page number for pagination

per_pageinteger

Number of items per page

created_by_emailstring

Filter by the creator's email address.

created_afterstring date-time

Filter resources created at or after this timestamp.

created_beforestring date-time

Filter resources created at or before this timestamp.

updated_afterstring date-time

Filter resources updated at or after this timestamp.

updated_beforestring date-time

Filter resources updated at or before this timestamp.

external_sourcestring

External ID source to filter by. Must be provided with external_id.

external_idstring

External ID value to filter by. Must be provided with external_source.

sort_by'created_at' | 'updated_at' | 'name' | 'id'

Sort field.

sort_order'asc' | 'desc'

Sort direction.

Response

Successful response

successboolean required
messagestring required
pageinteger required
per_pageinteger required
totalinteger required
pagesinteger required