Clients Endpoints (v1)

This section documents all client (customer) management endpoints within workspaces.

note

Important: "Clients" here refers to customers/clients of the workspace, not the workspace itself. All client operations are scoped to a specific workspace.

Client Management

• List Clients - Get all clients in a workspace
• Create Client - Create a new client
• Get Client - Get a single client by ID
• Update Client - Update an existing client
• Delete Client - Delete a client
• Upload Client Avatar - Upload avatar image
• Delete Client Avatar - Remove avatar image

Client Fields

• List Client Fields - Get all custom field definitions
• Create Client Field - Create a new custom field
• Update Client Field - Update a field definition
• Reorder Client Fields - Change field display order
• Archive Client Field - Archive a field
• Restore Client Field - Restore an archived field
• Upload Client Field Asset - Upload file for file/image/signature fields
• Delete Client Field - Permanently delete a field