Agendor icon

Agendor

Integração completa com Agendor CRM
Join our community

Actions19

Overview

This node integrates with the Agendor CRM platform to search for people ("Pessoa") based on various criteria. It supports searching by unique ID, email address, phone number, CPF (Brazilian individual taxpayer registry identification), or listing all people. This functionality is useful in scenarios where you need to retrieve detailed information about contacts stored in Agendor, such as for customer management, marketing campaigns, or data synchronization.

Practical examples include:

  • Fetching a person's details by their unique Agendor ID to update records.
  • Searching for a person by email to verify if they exist before creating a new contact.
  • Listing all people in the CRM for bulk processing or reporting.

Properties

Name Meaning
Tipo de Busca Search type; options: Por ID, Por E-mail, Por Telefone, Por CPF, Listar Todos
ID da Pessoa Unique ID of the person in Agendor (required when searching by ID)
E-mail Email address of the person (required when searching by email)
Telefone Phone number (digits only) of the person (required when searching by phone)
CPF CPF number (digits only) of the person (required when searching by CPF)
Incluir Campos Customizados Boolean flag to include custom fields in the response
Retornar Todos Boolean flag indicating whether to return all results when listing all people
Limite Maximum number of results to return when not returning all (range 1-100, default 50)

Output

The node outputs JSON data representing the person(s) retrieved from Agendor. The structure depends on the search type:

  • For searches by ID, email, phone, or CPF, the output is a single person object with detailed fields.
  • For "Listar Todos" (list all), the output is an array of person objects, each containing standard and optionally custom fields.

If the "Incluir Campos Customizados" option is enabled, the output includes additional custom fields defined in the Agendor CRM for each person.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Agendor CRM API.
  • The node uses HTTP requests to Agendor's REST API endpoints.
  • No other external dependencies are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing an incorrect or non-existent person ID/email/phone/CPF will result in empty responses or errors.
    • Exceeding API rate limits may cause request failures.
    • When listing all people without enabling "Retornar Todos," the results are limited by the "Limite" property.

  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly configured.
    • Not found errors: Check that the search parameter (ID, email, etc.) is correct and exists in Agendor.
    • Validation errors: Ensure required properties for the selected search type are provided.
    • Network or timeout errors: Confirm network connectivity and Agendor service availability.

Links and References

Discussion