CV CRMInstall

Summary

Search for leads using various optional parameters such as ID, email, or phone number.

Inputs

• idlead — ID of the lead to search (optional)
• email — Email of the lead to search (optional)
• telefone — Phone number of the lead to search (optional)
• idcorretor — ID of the agent responsible for the lead (optional)
• idsituacao — ID of the situation in the workflow (optional)
• ativo — Whether to return only active leads (optional)
• tarefasPendentes — Whether to return only leads with pending tasks (optional)
• tarefasVencidas — Whether to return only leads with overdue tasks (optional)
• limit — Max number of results to return, defaults to 50
• offset — Offset of the beginning of the results (should not be used when a lead is specified)

Output shape

a list of leads matching the search criteria

Returns an array of leads, which may include metadata regarding the search; handles cases where no leads are found.

Examples

Example 1: Searching for a lead by email

Set the 'email' parameter to the lead's email address and leave others blank.

Example 2: Fetching active leads with pending tasks

Set the 'ativo' and 'tarefasPendentes' options to true, and define a 'limit' for the number of results.