ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Contacts → Contact Search

AI-generated

Summary

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.

Discussion