The Options field inside n8n nodes allows you to adjust and refine the behavior of requests made to the API. It provides six main parameters: Search, Include, Order, Page, PerPage, and Query.
Below is the detailed explanation of each one, with practical examples:

Search

Allows searching for records containing a specific term.

• Example: typing Pedro → the API returns only records related to that name.
• Ideal for locating contacts, users, or companies without having to go through the entire database.

Order

Controls the display order of results.

• For ascending order (default), simply enter the field directly.
  Example: created_at → sorts from oldest to newest.
• For names or texts, the ordering will be A → Z (as shown in the image).
• For descending order, add a hyphen - before the field.
  Example: -created_at → sorts from newest to oldest.

Page

Defines which page of results should be displayed when the API works with pagination.

• Example: if there are 200 records and the limit is 50 per page, page 2 will show records 51 to 100.
  Very useful when working with large data volumes.

PerPage

Determines how many records will be displayed on each page.

• Example: set 100 records per page instead of the default (usually 20 or 50).
  Provides greater control over performance and the amount of information returned.

Query

Works as a blank field for custom filters.
You can manually type the desired conditions according to the parameters accepted by the API.
Practical examples:

• name=Pedro → returns only records whose name is “Pedro”.
• id=7 → returns only the record with ID 7.

It is also possible to combine different filters, depending on the rules of the API used.

Include

The Include parameter is used to bring additional information along with the main data of each request.
Each node has specific Includes, but some are repeated across different nodes.

Tip: If you don’t find the explanation of an Include in the node you are checking, verify if the same Include appears in another node. Since the returned data is standardized, the explanation will usually be valid as well.

Below are the available Includes for each node, with practical usage explanations:

1. List Teams

When the node returns teams, it is possible to include extra data related to the team.

• Key → Team identifier.
  Examples: finance, commercial, pre-sales, onboarding, tech-support, after-sales, expansion.
• Status → Team status.
  Possible values: active, inactive, online, offline, unavailable.
• Visibility → Defines whether the team is public or private.
  Values: public, private.
• Staging → Team stage.
  Common value: requested.
• Attributes → Additional team information.
  Example: name (Commercial, Finance, etc.), description.
• Users → List of users associated with the team.
  Includes: user status, service status, email, ID, name.
• Metadata → Creation and update information.
  Fields: created_at, updated_at.

2. List and Search Contact

Allows searching and listing contacts, with the possibility of including additional data.

• Type → Type of contact.
  Values: person or group.
• Chat status → Conversation status.
  Values: chat_closed, chat_in_progress.
• Read status → Message read status.
  Values: read, unread.
• Attributes → Basic contact data.
  Example: name, phone, email, cpf/cnpj.
• Account → Account data associated with the contact.
  Example: name, cnpj, phone, segment, account_uuid.
• Attendant → Attendant responsible for the contact.
  Example: name, attendant_uuid.
• Contact channels → Channels associated with the contact.
  Fields: channel_uuid, provider (WhatsApp, etc.), type (default).
• Current attendance → Information about the current attendance.
  Includes: status, type (e.g.: INITIATED_BY_FORWARDING, INITIATED_BY_BUSINESS), as well as metadata (created_at, updated_at).
• Last message → Last message exchanged with the contact.
  Includes: timestamp, provider, metadata, components (message content).
• Tags → Labels applied to the contact.
  Fields: tag_uuid, name, color.
• Addresses → Addresses linked to the contact.
• Metadata → Additional creation and update information.

3. List Messages from Contact ID

Used to view specific messages from a contact.

• Components → Represents the body of the message.
  Example: body (the text of the message itself).

4. List and Search Users

Provides information about system users, allowing inclusion of extra details.

• Status → User status.
  Example: active, inactive.
• Status of service → Availability for attendance.
  Example: available, unavailable.
• Email → User’s registered email.
• Attributes → Additional information.
  Example: name.
• Roles → Roles assigned to the user.
  Examples: manager, supervisor, chat operator.
  Includes: role UUID and metadata.
• Permissions → User permissions.
  Example: view channels, view contacts, send messages, etc.
  Includes: permission UUIDs.
• Active account → Active account linked to the user.
  Fields: account_uuid, metadata, name, cnpj.
• Account channels → Channels associated with the account.
  Example: name, channel_uuid, status, provider.
• Accounts → Other accounts/companies linked to the user.
• Teams → Teams the user is part of.
  Example: commercial, finance, pre-sales, etc.
• Addresses → Registered addresses.
• Metadata → Creation and update information.

5. List Channels

Allows listing communication channels, including additional information.
(The Includes here are similar to those for contacts, as they are directly related to the communication flow.)

• Type → Channel type.
• Chat status → Conversation status in the channel.
• Read status → Read status.
• Attributes → Additional channel data.
• Account → Account associated with the channel.
• Attendant → Responsible user.
• Contact channels → Links between channel and contact.
• Current attendance → Active attendance.
• Last message → Last message received or sent.
• Tags → Applied tags.
• Addresses → Linked addresses.
• Metadata → Creation and update information.

6. Get Channel

In the Get Channel node, the only available Include is Config, which returns WhatsApp channel configuration information.

• business_id → Company ID in Business Manager.
• business_name → Company name in Business Manager.
• waba_id → WhatsApp Business Account (WABA) ID.
• waba_name → WABA account name (e.g., [Prod][Official] Poli).
• phone_id → Identifier of the registered WhatsApp number.
• phone_name → Name assigned to the number (e.g., Poli).
• phone_number → WhatsApp number linked to the channel (in international format).
• business_management → Number and account management data.
• phone_id → Internal UUID of the number.
• whatsapp_account_id → Internal UUID of the WhatsApp account.