Actions51
- Client Actions
- Custom API Call Actions
- Domain Actions
- Invoice Actions
- Order Actions
- Product / Service Actions
- System Actions
- Ticket Actions
Client → Get
AI-generatedSummary
Retrieve a client by ID or email
Inputs
- clientid — Numeric ID of the client; use 0 to search by email instead.
- email — Email address of the client; used when clientid is 0.
- customParameters — Additional WHMCS parameters (name/value pairs) to include in the API call. Names must match the WHMCS API Reference exactly.
Output shape
a client record
Returns the client object from WHMCS; when operation is GetMany it may return multiple records, otherwise a single object. Optional fields are included as present; errors are raised.
Examples
Example 1: Lookup a client by numeric ID
Resource = Client, Operation = Get, Client ID = 123, Email left blank
Example 2: Lookup a client by email
Resource = Client, Operation = Get, Email = user@example.com, Client ID = 0
Example 3: Add custom WHMCS parameters
Resource = Client, Operation = Get, Custom Parameters → add Parameter (Name: customfields, Value: "somevalue")