AgendorInstall

Summary

Search for people in the Agendor CRM by various criteria including ID, email, phone number, CPF, or list all people.

Inputs

• searchType (required) — Select the type of search to perform: by ID, email, phone, CPF, or list all people.
• personId (required) — Specify the unique person ID to search by when 'Por ID' is selected.
• email (required) — Provide the email address to search by when 'Por E-mail' is selected.
• phone (required) — Provide the phone number (digits only) to search by when 'Por Telefone' is selected.
• cpf (required) — Provide the CPF (digits only) to search by when 'Por CPF' is selected.
• withCustomFields — Optionally include custom fields in the search result.
• returnAll — When listing all people, choose whether to return all results or limit the number returned.
• limit — When listing all people and not returning all, specify the maximum number of persons to return (1-100).

Output shape

a single record for ID/email/phone/CPF search; or a list of people records when listing all

When listing all, results can be limited or returned entirely based on the 'returnAll' parameter. Custom fields are included in results if 'withCustomFields' is true. Errors may be included in the output on failure if 'Continue on Fail' is enabled.

Examples

Example 1: Search a person by ID

Set 'Tipo de Busca' to 'Por ID' and provide 'ID da Pessoa'.

Example 2: Search a person by email

Set 'Tipo de Busca' to 'Por E-mail' and provide the email address.

Example 3: List all people with a limit

Set 'Tipo de Busca' to 'Listar Todos', enable 'returnAll' as false, and specify 'Limite'.