Dolibarr icon

Dolibarr

Interact with Dolibarr API

Overview

This node interacts with the Dolibarr API to list events stored in a Dolibarr system. It allows users to retrieve event records with flexible filtering, sorting, and pagination options. This is useful for scenarios where you want to integrate Dolibarr event data into workflows, such as syncing events with calendars, generating reports, or triggering actions based on event details.

For example, you could use this node to:

  • Fetch all upcoming events sorted by date.
  • Retrieve events owned by specific users.
  • Apply custom SQL-like filters to narrow down the event list.
  • Paginate through large sets of events efficiently.

Properties

Name Meaning
Sort Field The field by which to sort the returned events (e.g., "t.id").
Sort Order The order of sorting: either ascending (ASC) or descending (DESC).
Limit Maximum number of event results to return per request.
Page The page number to query for paginated results (starting from 0).
Get All Whether to return all matching events ignoring the limit, or just up to the specified limit.
User IDs Filter events by owner user IDs; can specify one or multiple IDs separated by commas.
SQL Filters Additional SQL-like filter criteria to apply to the event query, allowing complex conditions.

Output

The node outputs an array of event objects in the json output field. Each object represents an event record retrieved from Dolibarr, containing fields as defined by the Dolibarr API for events. The exact structure depends on the API response but typically includes event identifiers, labels, dates, owners, and other metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires a valid Dolibarr API credential with appropriate permissions to access event data.
  • Needs the base URL of the Dolibarr instance configured in the credentials.
  • Relies on the Dolibarr REST API endpoint /api/index.php for fetching event data.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid filter syntax in the SQL Filters property may result in API errors.
    • Requesting pages beyond available data may return empty results.
  • Error messages:
    • Authentication errors indicate invalid or expired API keys; verify and update credentials.
    • HTTP 404 errors when querying may mean the resource or filters do not match any records.
    • Syntax errors in SQL Filters should be corrected according to Dolibarr's expected filter format.

Links and References

Discussion