List opportunities with the Keap API

Lists the opportunities of the sales pipeline in opportunities, each with its contact, stage and user, and next_page_token for the following page.

Identifier
keap_list_opportunities

The request

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

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

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
filterstringNoFilters joined by ;, each one field==value, for example stage_id==3;user_id==5. Fields: stage_id (from List opportunity stages), user_id (from List users), contact_id (from List contacts), opportunity_title (with * for a prefix), ids (comma-separated, from List opportunities, up to 100), projected_revenue_low and projected_revenue_high (also with greater-than or less-than comparisons).
order_bystringNoField and direction separated by a space: next_action_time, contact_name, opportunity_title, created_time or update_time, then asc or desc, for example created_time desc.
page_sizeintegerNoOpportunities per page, up to 1000.
page_tokenstringNoThe next_page_token of the previous response. Omit it on the first page.

Supported connections

Your customer connects their Keap 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/keap, 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/keap_list_opportunities. 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.