Actions22
Overview
This node operation lists clients from a FreshBooks account. It is useful for retrieving client data such as contact details, status, and creation or update timestamps. Typical use cases include syncing client lists with other systems, generating reports on active or archived clients, or filtering clients based on visibility state and sorting preferences.
For example, you might use this node to:
- Fetch all active clients to send them a newsletter.
- Retrieve a limited number of recently updated clients for quick review.
- List archived clients for auditing purposes.
Properties
| Name | Meaning |
|---|---|
| Account ID | Your FreshBooks Account ID, found in your account settings (e.g., "eNVq4"). |
| Return All | Whether to return all matching clients or limit the results. |
| Limit | Maximum number of clients to return if not returning all (minimum 1). |
| Search Visibility State | Filter clients by visibility: "Active" (0) or "Archived" (1). |
| Sort Order | Order in which clients are returned: |
| - Updated (Newest First) | |
| - Updated (Oldest First) | |
| - Created (Newest First) | |
| - Created (Oldest First) |
Output
The output consists of an array of JSON objects, each representing a client retrieved from FreshBooks. Each object contains client details as provided by the FreshBooks API under the json property.
No binary data is output by this node operation.
Dependencies
- Requires a valid FreshBooks API authentication token configured in n8n credentials.
- The user must provide their FreshBooks Account ID.
- The node makes HTTP GET requests to the FreshBooks API endpoint for clients, specifically to
/accounting/account/{accountId}/users/clients.
Troubleshooting
- Missing or invalid Account ID: The node requires a correct Account ID; ensure it matches the one in your FreshBooks account settings.
- Authentication errors: Verify that the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
- Empty results: Check the visibility filter (
Search Visibility State) and sorting options; also verify that clients exist in the specified state. - Limit vs Return All: If
Return Allis false but the limit is set too low, you may get fewer results than expected. - API rate limits: If many clients are requested with
Return Allenabled, be mindful of FreshBooks API rate limits.