Actions51
- Client Actions
- Custom API Call Actions
- Domain Actions
- Invoice Actions
- Order Actions
- Product / Service Actions
- System Actions
- Ticket Actions
Client → Get Many
AI-generatedSummary
Retrieve multiple client records from WHMCS.
Inputs
- returnAll — Whether to return all results or only up to a given limit
- limit — Max number of results to return; defaults to 50 and must be at least 1
- filters — Collection of filter options (search, status, sorting) to narrow the client list
- customParameters — Any additional WHMCS parameter not covered by the above fields; names must match the WHMCS API Reference exactly (case-sensitive)
Output shape
an array of client objects
Pagination controlled by limit and returnAll; optional filter fields; response may include error details if the call fails.
Examples
Example 1: Get the first 20 active clients
returnAll:false, limit:20, filters:{status:'Active'}
Example 2: Search for clients matching a keyword
filters:{search:'Acme'}, returnAll:true
Example 3: Fetch all clients with custom field 'customfields' set
customParameters:{parameter:[{name:'customfields',value:'VIP'}]}