List Clients (v1)

Method + Path

GET /v1/workspace/:workspaceId/clients

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

Description

Get a list of all clients (customers) in a workspace.

Authentication

Required - JWT token in Authorization header

Required Permissions:

• clients.view

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Response (200)

{
  "clients": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "John Doe",
      "avatarUrl": "https://example.com/avatar.jpg",
      "contactMethods": [
        {
          "type": "phone",
          "value": "+1234567890",
          "isPreferred": true
        }
      ],
      "customFields": [],
      "createdAt": "2024-01-15T10:00:00Z"
    }
  ]
}

Common Errors

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