List contacts with the Salesflare API

Lists the contacts of the team, 20 per page by default. Paginate with limit and offset; a page shorter than limit is the last one.

Identifier
salesflare_list_contacts

The request

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

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

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
searchstringNoText to search for in the contacts.
namestringNoName of the contact.
emailstringNoEmail address of the contact.
phone_numberstringNoPhone number of the contact.
domainstringNoDomain of the email address, such as acme.com.
accountarrayNoIds of accounts, from List accounts: only the contacts linked to them.
includeArchivedbooleanNoAlso returns archived contacts.
order_byarrayNoSort keys, each a field name for ascending or the name followed by desc, such as name desc.
limitintegerNoContacts per page. The default is 20.
offsetintegerNoContacts to skip, for the next page.

Supported connections

Your customer connects their Salesflare 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/salesflare_list_contacts. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

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