Skip to main content

List Staff (v1)

Method + Path

GET /v1/workspace/:workspaceId/staff

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

Description

Get a list of all staff members in a workspace.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • staff.view

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Response (200)

{
"staff": [
{
"id": "507f1f77bcf86cd799439011",
"fullName": "John Doe",
"email": "john@example.com",
"permissions": ["sessions.view", "sessions.create"],
"status": "active",
"avatarUrl": "https://example.com/avatar.jpg",
"customFields": [],
"createdAt": "2024-01-15T10:00:00Z"
}
]
}

Common Errors

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