List Client Fields (v1)

Method + Path

GET /v1/workspace/:workspaceId/clients/fields

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

Description

Get a list of all custom field definitions for clients in a workspace.

Authentication

Required - JWT token in Authorization header

Required Permissions:

• clients.view or clients.update

Headers

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

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Query Parameters

Parameter	Type	Required	Description
includeArchived	string	No	Include archived fields. Valid values: true, false. Default: false

Response (200)

{
  "fields": [
    {
      "id": "507f1f77bcf86cd799439011",
      "key": "notes",
      "label": "Notes",
      "description": "Additional notes about the client",
      "type": "text",
      "isRequired": false,
      "isUnique": false,
      "isFilterable": true,
      "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