Search contacts with the Intercom API
Searches contacts by their attributes, for example by email, role or a custom attribute. Timestamps are Unix seconds in UTC. Returns total_count and data, 50 per page by default, and the next page comes from pages.next.starting_after. A contact created in the last few minutes may not show up yet.
- Identifier
- intercom_search_contacts
The request
POST https://connect.reportei.com/api/tools/intercom_search_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"query": {}
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | object | Yes | Filters joined by AND or OR, up to 15 in the group. One filter also goes in the value list. |
| pagination | object | No | Page size and cursor. |
| sort | object | No | Sort of the results. |
Supported connections
Your customer connects their Intercom account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/intercom, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
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/intercom_search_contacts. It becomes your agent's tool definition with no conversion.
Other Intercom tools
- List contactsGETLists the contacts of the workspace, users and leads, 10 per page by default. The next page comes from pages.next.starting_after in the response; without it, this is the last page. Merged contacts do not appear.
- Get contactGETReturns one contact with role, email, phone, name, owner_id, custom_attributes, tags, companies and location. A contact merged into another returns 410.
- Create contactPOSTCreates a contact, a user or a lead. Send at least one of email, external_id or role. Every custom attribute sent must already exist in the workspace, or Intercom refuses the contact.
- Update contactPUTUpdates a contact: send only the fields to change. A user cannot become a lead. Every custom attribute sent must already exist in the workspace.
- List conversationsGETLists the conversations of the workspace, 20 per page by default. The next page comes from pages.next.starting_after in the response; without it, this is the last page. Get conversation returns all the parts of one conversation.
- Search conversationsPOSTSearches conversations by their attributes, for example the open ones assigned to a teammate or a team. Timestamps are Unix seconds. Returns total_count and conversations, 20 per page by default, and the next page comes from pages.next.starting_after.
- Get conversationGETReturns one conversation with its parts (messages, notes and actions), up to the 500 most recent ones, plus state, assignees, contacts and tags.
- Create conversation replyPOSTReplies to a conversation as a teammate. A comment goes to the contact through the channel of the conversation, such as the Messenger or email; a note stays internal, visible only to teammates. Closing, snoozing, reopening and assigning are done by Manage conversation.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
