Retrieves all clients for a FreshBooks account. Clients are entities you send invoices to. Supports pagination, filtering by email/user ID/visibility state, sorting, and includes optional balance data (outstanding, credit, draft, overdue).
pageintegerPage number for pagination. Pages are 1-indexed.
sortstringSort results by field: client_id, organization_name, email, updated, fullname, or outstanding.
includearrayInclude additional balance data in response. Options: outstanding_balance, credit_balance, draft_balance, overdue_balance.
per_pageintegerNumber of results per page. Default is 15.
account_idRequiredstringUnique identifier of the FreshBooks account. Obtain this from the List Businesses action (use the account_id field from the business object).
search_emailstringFilter by exact email address match.
search_useridintegerFilter by exact user ID match.
search_vis_statestringVisibility state for clients.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.