List contacts with the Freshdesk API

Lists contacts, the customers who raise tickets, with id, name, email, phone, mobile, company_id, tags and custom_fields. Filters combine, and only unblocked and undeleted contacts come by default. Pages are numbered from 1; a page with fewer contacts than per_page is the last one.

Identifier
freshdesk_list_contacts

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "email": "<email>"
  }
}

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
emailstringNoOnly the contact with this email address.
mobilestringNoOnly contacts with this mobile number.
phonestringNoOnly contacts with this phone number.
company_idintegerNoOnly the contacts of this company, from Search companies.
statestringNoOnly contacts in this state.Values: blocked, deleted, unverified, verified
updated_sincestringNoOnly contacts updated at or after this UTC time, for example 2026-10-01T00:00:00Z.
pageintegerNoPage number, starting at 1.
per_pageintegerNoContacts per page, up to 100. The default is 30.

Supported connections

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

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {domain}: the address of their account on the app's API.

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/freshdesk_list_contacts. It becomes your agent's tool definition with no conversion.

Other Freshdesk tools

See all 13 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.