Actions28
Overview
This node interacts with the Dolibarr API to list contacts stored in a Dolibarr system. It allows users to retrieve multiple contact records with various filtering, sorting, and pagination options. This is useful for scenarios where you need to synchronize contact data, generate reports, or integrate Dolibarr contacts into other workflows.
For example, you could use this node to:
- Fetch all contacts sorted by their ID in ascending order.
- Retrieve a specific page of contacts filtered by category or linked third-party IDs.
- Get contacts including additional details like roles or usage counts.
Properties
| Name | Meaning |
|---|---|
| Sort Field | The field by which to sort the contacts (e.g., "t.rowid"). |
| Sort Order | The order of sorting: either ascending (ASC) or descending (DESC). |
| Limit | Maximum number of contacts to return per request. |
| Page | The page number to query (for pagination). |
| Get All | Whether to return all contacts ignoring the limit or just up to the specified limit. |
| Thirdparty IDs | Filter contacts by one or more third-party IDs (comma-separated string, e.g., "1" or "1,2,3"). |
| Category | Filter contacts by a specific category ID. |
| SQL Filters | Additional SQL-like filter criteria as a string to refine the contact search. |
| Include Count | Whether to include the count of elements linked to each contact. |
| Include Roles | Whether to include the roles associated with each contact. |
Output
The node outputs JSON data representing the list of contacts retrieved from Dolibarr. Each item in the output corresponds to a contact record with its fields as returned by the Dolibarr API. If enabled, additional fields such as usage counts and roles are included.
If binary data were involved (not indicated here), it would typically represent files or attachments related to contacts, but this node focuses on JSON contact data only.
Dependencies
- Requires an active connection to a Dolibarr instance via its REST API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The base URL of the Dolibarr API must be set in the credentials configuration.
Troubleshooting
- Empty results: Check that filters like
thirdpartyIDs,category, orsqlfiltersare correctly formatted and correspond to existing data. - Authentication errors: Ensure the API key or token is valid and has sufficient permissions.
- Pagination issues: When using
Get All = false, verify thatlimitandpageparameters are set properly to avoid missing data. - Invalid sort field: Using a non-existent or misspelled sort field may cause errors or unexpected results.
- API rate limits or downtime: Network or server issues can cause request failures; retry or check Dolibarr server status.