Dolibarr icon

Dolibarr

Interact with Dolibarr API

Actions28

Contact → List

AI-generated

Overview

This node operation lists contacts from the Dolibarr API. It allows users to retrieve a filtered and sorted list of contacts with options to paginate, limit the number of results, and include additional information such as roles and usage counts. This is useful for scenarios where you need to manage or analyze contact data from Dolibarr, such as syncing contacts to another system, generating reports, or filtering contacts based on specific criteria.

Use Case Examples

  1. Retrieve a list of contacts sorted by their ID in ascending order, limited to 50 results per page.
  2. Get all contacts filtered by specific third-party IDs or categories.
  3. Include roles and usage counts of contacts in the returned data for detailed analysis.

Properties

Name Meaning
Sort Field Field by which to sort the list of contacts.
Sort Order Order in which to sort the contacts, either ascending or descending.
Limit Maximum number of contacts to return in the response.
Page Page number of the results to query for pagination.
Get All Whether to return all contacts or limit the results to the specified number.
Thirdparty IDs Filter contacts by specific third-party IDs, provided as a comma-separated string.
Category Filter contacts by a specific category ID.
SQL Filters Additional SQL-like filter criteria to apply to the contact list query.
Include Count Whether to include the count of elements linked to each contact.
Include Roles Whether to include the roles associated with each contact.
Request Options Additional request settings such as batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • contacts - Array of contact objects returned from the Dolibarr API.
  • totalCount - Total number of contacts available (if includeCount is true).
  • roles - Roles associated with each contact (if includeRoles is true).

Dependencies

  • Dolibarr API with valid API key credentials

Troubleshooting

  • Ensure the Dolibarr API credentials are correctly configured and have the necessary permissions to access contact data.
  • If the node returns no results, verify the filter criteria such as third-party IDs, category, and SQL filters are correctly formatted and valid.
  • Timeout errors may occur if the server is slow or unresponsive; adjust the timeout setting in Request Options accordingly.
  • If SSL certificate validation fails, enable the 'Ignore SSL Issues' option in Request Options to bypass certificate errors.

Discussion