Skip to main content

List Sessions (v1)

Method + Path

GET /v1/workspace/:workspaceId/sessions

Actual backend path: /v1/workspace/:workspaceId/sessions

Description

Get a list of all sessions in a workspace, optionally filtered by client, date range, or status.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • sessions.view

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Query Parameters

ParameterTypeRequiredDescription
clientIdstringNoFilter by client ID
dateFromstringNoFilter sessions from this date (ISO 8601 datetime)
dateTostringNoFilter sessions to this date (ISO 8601 datetime)
statusstringNoFilter by status. Valid values: scheduled, in-progress, completed, cancelled

Response (200)

{
"sessions": [
{
"id": "507f1f77bcf86cd799439011",
"name": "Consultation Session",
"clientId": "507f1f77bcf86cd799439012",
"scheduledAt": "2024-01-20T10:00:00Z",
"status": "scheduled",
"duration": 60,
"createdAt": "2024-01-15T10:00:00Z"
}
]
}

Common Errors

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