Search contacts with the Chatwoot API

Searches the contacts that have an identifier, email or phone, by name, identifier, email or phone number, 15 per page. Each contact has contact_inboxes, pairing each inbox with the source_id that Create conversation needs. meta.count is the total; a page with fewer than 15 contacts is the last one.

Identifier
chatwoot_search_contacts

The request

POST https://connect.reportei.com/api/tools/chatwoot_search_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
account_idintegerYesId of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123.
qstringNoText matched against the name, identifier, email or phone number of the contact.
sortstringNoSort field; a leading minus sorts in descending order.Values: name, email, phone_number, last_activity_at, -name, -email, -phone_number, -last_activity_at
pageintegerNoPage number, starting at 1.

Supported connections

Your customer connects their Chatwoot account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/chatwoot_search_contacts. It becomes your agent's tool definition with no conversion.

Other Chatwoot tools

See all 15 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.