Tool to list customers who have interacted with your bot. Use when you need to retrieve customer records with optional filters (channel_id, opt_in, search) and pagination.
limitintegerMaximum number of records to return per request.
offsetintegerNumber of records to skip before returning results.
opt_inbooleanFilter only customers who have opted in (e.g., WhatsApp opt-in).
searchstringValue to search for in the specified field.
search_bystringField to search by. Must be one of 'phone', 'email', or 'name'.
channel_idintegerFilter by specific channel ID through which customers interact.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.