> ## Documentation Index > Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List candidates candidates > Requires scopes: eval:read ## OpenAPI ````yaml /api-reference/openapi.json get /api/candidates openapi: 3.1.0 info: title: EvalGate API version: 3.7.6 description: EvalGate API. See docs/api-contract.md for stability commitments. servers: - url: https://evalgate.com description: Production - url: http://localhost:3000 description: Local security: [] paths: /api/candidates: get: tags: - candidates summary: List candidates candidates description: 'Requires scopes: eval:read' operationId: get_candidates parameters: - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 1000 default: 50 - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 - name: auto_promote_eligible in: query required: false schema: type: string - name: status in: query required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/GetApiCandidatesResponse200ApplicationJson '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' security: - bearerAuth: - eval:read components: schemas: GetApiCandidatesResponse200ApplicationJson: type: object properties: candidates: type: array items: type: object properties: id: type: number organizationId: $ref: '#/components/schemas/OrganizationId' failureReportId: oneOf: - type: 'null' - type: number traceId: oneOf: - type: 'null' - type: number title: type: string tags: oneOf: - type: 'null' - type: array items: type: string sourceTraceIds: oneOf: - type: 'null' - type: array items: type: string expectedConstraints: oneOf: - type: 'null' - type: array items: type: object properties: type: type: string value: $ref: '#/components/schemas/JsonValue' required: type: boolean description: type: string additionalProperties: false required: - type - value - required minimizedInput: oneOf: - type: 'null' - type: object properties: userPrompt: type: string systemPrompt: oneOf: - type: 'null' - type: string activeTools: type: array items: type: string conversationContext: type: array items: type: object properties: role: oneOf: - type: string enum: - user - type: string enum: - system - type: string enum: - developer - type: string enum: - tool - type: string enum: - tool_result - type: string enum: - assistant content: type: string additionalProperties: false required: - role - content failureSpanId: oneOf: - type: 'null' - type: string failureOutput: oneOf: - type: 'null' - type: string metadata: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' agentWorkflow: type: object properties: version: type: number enum: - 1 workflowClass: oneOf: - type: string enum: - approval_gated_mutation - type: string enum: - background_execution - type: string enum: - recovery_required - type: string enum: - policy_conflict - type: string enum: - handoff_heavy - type: string enum: - memory_sensitive - type: string enum: - parallel_tool_use autonomyLevel: oneOf: - type: string enum: - manual - type: string enum: - default_approvals - type: string enum: - bypass_approvals - type: string enum: - autopilot approvalMode: oneOf: - type: string enum: - human_review - type: string enum: - none - type: string enum: - policy_guided - type: string enum: - auto_with_audit riskLevel: oneOf: - type: string enum: - low - type: string enum: - medium - type: string enum: - high - type: string enum: - critical memoryMode: oneOf: - type: string enum: - session - type: string enum: - none - type: string enum: - persistent - type: string enum: - mixed backgroundExecution: type: boolean requiresCheckpoint: type: boolean expectedHandoff: type: boolean requiredHooks: type: array items: oneOf: - type: string enum: - session_start - type: string enum: - pre_plan - type: string enum: - pre_tool - type: string enum: - post_tool - type: string enum: - pre_write - type: string enum: - pre_handoff - type: string enum: - on_error - type: string enum: - session_end activeTools: type: array items: type: string permissionScope: type: object properties: filesystem: type: array items: type: string network: oneOf: - type: string enum: - open - type: string enum: - restricted - type: string enum: - none externalSystems: type: array items: type: string mutatesState: oneOf: - type: boolean enum: - false - type: boolean enum: - true additionalProperties: false expectedFailureModes: type: array items: type: string scenario: type: string provenance: type: object properties: source: oneOf: - type: string enum: - manual - type: string enum: - evaluation_run - type: string enum: - coverage_gap - type: string enum: - trace_failure evaluationId: type: number runId: type: number testCaseId: type: number traceId: oneOf: - type: 'null' - type: string additionalProperties: false required: - source additionalProperties: false required: - version - workflowClass - autonomyLevel - approvalMode - riskLevel - memoryMode - backgroundExecution - requiresCheckpoint - expectedHandoff - requiredHooks - activeTools - permissionScope - expectedFailureModes - scenario workflowExperimentRecipe: oneOf: - type: 'null' - type: object properties: version: type: number enum: - 1 title: type: string objective: type: string workflowClass: oneOf: - type: string enum: - approval_gated_mutation - type: string enum: - background_execution - type: string enum: - recovery_required - type: string enum: - policy_conflict - type: string enum: - handoff_heavy - type: string enum: - memory_sensitive - type: string enum: - parallel_tool_use source: oneOf: - type: string enum: - coverage_gap - type: string enum: - failure linkedFailureModes: type: array items: type: string linkedTestCaseIds: type: array items: type: number comparedVariants: type: array items: type: object properties: id: type: string label: type: string changes: type: array items: type: string autonomyLevel: oneOf: - type: string enum: - manual - type: string enum: - default_approvals - type: string enum: - bypass_approvals - type: string enum: - autopilot approvalMode: oneOf: - type: string enum: - human_review - type: string enum: - none - type: string enum: - policy_guided - type: string enum: - auto_with_audit memoryMode: oneOf: - type: string enum: - session - type: string enum: - none - type: string enum: - persistent - type: string enum: - mixed hooks: type: array items: oneOf: - type: string enum: - session_start - type: string enum: - pre_plan - type: string enum: - pre_tool - type: string enum: - post_tool - type: string enum: - pre_write - type: string enum: - pre_handoff - type: string enum: - on_error - type: string enum: - session_end expectedImpact: type: string additionalProperties: false required: - id - label - changes - expectedImpact successMetrics: type: array items: type: string guardrails: type: array items: type: string recommendedIterations: type: number rationale: type: string additionalProperties: false required: - version - title - objective - workflowClass - source - linkedFailureModes - linkedTestCaseIds - comparedVariants - successMetrics - guardrails - recommendedIterations - rationale additionalProperties: false required: - userPrompt - systemPrompt - activeTools - conversationContext - failureSpanId - failureOutput - metadata evalCaseId: type: string qualityScore: oneOf: - type: 'null' - type: number qualityVerdict: oneOf: - type: 'null' - type: string autoPromoteEligible: type: boolean status: type: string lifecycleState: type: string evaluationId: oneOf: - type: 'null' - type: number dedupeHash: oneOf: - type: 'null' - type: string similarityGroupId: oneOf: - type: 'null' - type: string piiExposureScore: oneOf: - type: 'null' - type: number piiDominantType: oneOf: - type: 'null' - type: string reviewDecisionId: oneOf: - type: 'null' - type: number reviewRationale: oneOf: - type: 'null' - type: string editedFields: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' rejectionReason: oneOf: - type: 'null' - type: string duplicateOf: oneOf: - type: 'null' - type: number provenance: type: object properties: sourceTraceId: oneOf: - type: 'null' - type: string - type: number sourceSpanId: oneOf: - type: 'null' - type: string sourceToolCallId: oneOf: - type: 'null' - type: string sourceRunId: oneOf: - type: 'null' - type: string - type: number sourceTestResultId: oneOf: - type: 'null' - type: string - type: number sourceFailureMode: oneOf: - type: 'null' - type: string sourceClusterId: oneOf: - type: 'null' - type: string modelCallId: oneOf: - type: 'null' - type: string promptVersion: oneOf: - type: 'null' - type: string generatorVersion: oneOf: - type: 'null' - type: string dedupeHash: oneOf: - type: 'null' - type: string similarityGroupId: oneOf: - type: 'null' - type: string additionalProperties: false rationale: oneOf: - type: 'null' - type: string promotedToEvaluationId: oneOf: - type: 'null' - type: number reviewedBy: oneOf: - type: 'null' - type: string reviewedAt: oneOf: - type: 'null' - type: string format: date-time createdAt: type: string format: date-time additionalProperties: false required: - id - organizationId - failureReportId - traceId - title - tags - sourceTraceIds - expectedConstraints - minimizedInput - evalCaseId - qualityScore - qualityVerdict - autoPromoteEligible - status - lifecycleState - evaluationId - dedupeHash - similarityGroupId - piiExposureScore - piiDominantType - reviewDecisionId - reviewRationale - editedFields - rejectionReason - duplicateOf - provenance - rationale - promotedToEvaluationId - reviewedBy - reviewedAt - createdAt limit: type: number offset: type: number additionalProperties: false required: - candidates - limit - offset OrganizationId: type: string format: uuid JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ApiError: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_ERROR - SERVICE_UNAVAILABLE - QUOTA_EXCEEDED - NO_ORG_MEMBERSHIP - CROSS_ORG_REFERENCE - INCOMPLETE - MALFORMED message: type: string details: {} requestId: type: string format: uuid required: - code - message required: - error responses: ValidationError: description: Validation error content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' RateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key or Session Token ````