Skip to main content

List Evaluation Fields (v1)

Method + Path

GET /v1/workspace/:workspaceId/sessions/evaluation-fields

Actual backend path: /v1/workspace/:workspaceId/sessions/evaluation-fields

Description

Get all evaluation field definitions for sessions.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • sessions.view or sessions.update

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Query Parameters

ParameterTypeRequiredDescription
includeArchivedstringNoInclude archived fields. Valid values: true, false. Default: false

Response (200)

{
"fields": [
{
"id": "507f1f77bcf86cd799439011",
"key": "satisfaction-rating",
"label": "Satisfaction Rating",
"type": "number",
"isRequired": false,
"order": 1,
"createdAt": "2024-01-15T10:00:00Z"
}
]
}

Common Errors

  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Workspace not found
  • 500 Internal Server Error: Server error