Fale JáInstall

Summary

Retrieves multiple contacts from the Fale Já (Chatwoot) instance using the selected API type. Optionally return all contacts or limit results, and sort by name, email, or last activity.

Inputs

• API Type (required) — Select which API to use based on your role and use case (Application, Client, Platform). Determines the endpoint and permissions for the request. Defaults to Application API (value: 'application'). Provides access to conversations, contacts, messages, teams, reports and account settings for agents/admins; Client API for end‑user/customers via widgets or apps; Platform API for self‑hosted/reseller administrators managing multiple accounts, users and platform‑level configuration. This selection routes the request to the appropriate generic API helper (chatwootApiRequest, chatwootClientApiRequest or chatwootPlatformApiRequest).
• Return All — When true, the node will paginate through all matching contacts and return the complete set. When false, only a limited number of contacts (as defined by Limit) are returned. Default: false.
• Limit — Maximum number of contacts to return per page when Return All is false. Value must be between 1 and 100. Default: 50. Ignored when Return All is true.
• Options.Sort — Field and direction used to order the resulting contacts. Options: Name A‑Z (value: 'name'), Name Z‑A ('-name'), Email A‑Z ('email'), Email Z‑A ('-email'), Last Activity Recent First ('-last_activity_at'), Last Activity Oldest First ('last_activity_at'). Default: Name A‑Z ('name').

Output shape

array of objects

Each element represents a contact returned by the Fale Já API. The exact fields depend on the API version but typically include id, name, email, identifier, inbox_id, created_at, updated_at, last_activity_at, label_ids, custom_attributes, etc. When Return All is true, the array contains all matching contacts across pages; otherwise it contains up to Limit contacts.

Examples

Example 1: Fetch the first 20 contacts sorted by email descending using the Application API.

API Type: Application; Return All: false; Limit: 20; Options.Sort: Email (Z‑A).

Example 2: Retrieve every contact in the workspace, sorted by most recent activity, using the Platform API (self‑hosted).

API Type: Platform; Return All: true; Options.Sort: Last Activity At (Recent First).

Links

• n8n community nodes installation guide