Actions117
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Profile Actions
- N 8 N Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Contacts → Contact Search
AI-generatedSummary
Search contacts within a specific Chatwoot account by querying their name, identifier, email, or phone number, with options to sort and paginate results.
Inputs
- Account Id (required) — The numeric ID of the Chatwoot account to search contacts in.
- Q — Optional search string filtering contacts by name, identifier, email, or phone number.
- Sort — Attribute to sort the list of contacts by. Options include name, email, phone number, and last activity at, ascending or descending.
- Page — The page number of results to return for pagination, defaulting to 1.
Output shape
a list of contact objects matching the search criteria within the specified account
Results are paginated according to the 'Page' parameter, and can be sorted using the 'Sort' option. Additional request options like batching, proxy, and timeout can influence the request but do not affect the response shape.