List leads with the Instantly API

Lists leads with their email, names, company, status and interest status, up to limit per page. For the next page, pass next_starting_after as starting_after, until it stops coming back.

Identifier
instantly_list_leads

The request

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

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

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
campaignstringNoOnly leads of this campaign, by the id from List campaigns.
list_idstringNoOnly leads of this lead list, by the id from List lead lists.
searchstringNoWhole words, or the start of a value, matched against email, names, company and job title. Leads created a few seconds ago may not show yet.
filterstringNoOnly leads in this state, like FILTER_VAL_REPLIED for leads that replied or FILTER_LEAD_INTERESTED for leads marked as interested.Values: FILTER_VAL_CONTACTED, FILTER_VAL_NOT_CONTACTED, FILTER_VAL_COMPLETED, FILTER_VAL_UNSUBSCRIBED, FILTER_VAL_ACTIVE, FILTER_LEAD_INTERESTED, FILTER_LEAD_NOT_INTERESTED, FILTER_LEAD_MEETING_BOOKED, FILTER_LEAD_MEETING_COMPLETED, FILTER_LEAD_CLOSED, FILTER_LEAD_OUT_OF_OFFICE, FILTER_LEAD_WRONG_PERSON, FILTER_LEAD_LOST, FILTER_LEAD_NO_SHOW, FILTER_VAL_BOUNCED, FILTER_VAL_SKIPPED, FILTER_VAL_REPLIED, FILTER_VAL_OPENED_NO_REPLY, FILTER_VAL_COMPLETED_NO_REPLY, FILTER_VAL_NO_OPENS, FILTER_VAL_LINK_CLICKED
contactsarrayNoOnly leads with these emails.
idsarrayNoOnly these leads, by the id from a previous call of List leads.
in_campaignbooleanNoTrue for leads that are in a campaign, false for leads outside any campaign.
in_listbooleanNoTrue for leads that are in a lead list, false for leads outside any list.
limitintegerNoLeads per page, up to 100.
starting_afterstringNoThe next_starting_after of the previous page.

Supported connections

Your customer connects their Instantly 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/instantly_list_leads. 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.