Skip to main content

Get Session (v1)

Method + Path

GET /v1/workspace/:workspaceId/sessions/:sessionId

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

Description

Get a single session by ID.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • sessions.view

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
sessionIdstringYesSession identifier

Response (200)

{
"session": {
"id": "507f1f77bcf86cd799439011",
"name": "Consultation Session",
"clientId": "507f1f77bcf86cd799439012",
"scheduledAt": "2024-01-20T10:00:00Z",
"duration": 60,
"status": "scheduled",
"notes": "Initial consultation",
"customFields": [],
"attachments": [],
"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: Session or workspace not found
  • 500 Internal Server Error: Server error