List opportunities with the Salesflare API
Lists the opportunities, with stage, value, account and owner. close_after and close_before filter on close_date. Paginate with limit and offset; a page shorter than limit is the last one.
- Identifier
- salesflare_list_opportunities
The request
POST https://connect.reportei.com/api/tools/salesflare_list_opportunities/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
| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | No | Text to search for in the opportunities. |
| id | integer | No | Id of one opportunity, from List opportunities or Create opportunity, to read only that one. |
| name | string | No | Name of the opportunity. |
| pipeline | integer | No | Id of a pipeline, from List pipelines. |
| stage | integer | No | Id of a stage, from the stages of List pipelines. |
| account | integer | No | Id of an account, from List accounts. |
| owner | integer | No | Id of the owner, from List users. |
| closed | boolean | No | Filters by closed. |
| done | boolean | No | Filters by done. |
| min_value | number | No | Lowest value. |
| max_value | number | No | Highest value. |
| close_after | string | No | Only the opportunities with close_date after this moment, in ISO 8601. |
| close_before | string | No | Only the opportunities with close_date before this moment, in ISO 8601. |
| order_by | array | No | Sort keys, each a field name for ascending or the name followed by desc, such as value desc. |
| limit | integer | No | Opportunities per page. |
| offset | integer | No | Opportunities 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_opportunities. It becomes your agent's tool definition with no conversion.
Other Salesflare tools
- List accountsGETLists the accounts, the companies of the team, 10 per page by default. Paginate with limit and offset; a page shorter than limit is the last one.
- Get accountGETReturns one account with its addresses, email addresses, phone numbers, tags and custom fields.
- Create accountPOSTCreates an account, the company that contacts and opportunities belong to. Returns the new account with its id.
- Update accountPUTUpdates the given fields of an account.
- List contactsGETLists the contacts of the team, 20 per page by default. Paginate with limit and offset; a page shorter than limit is the last one.
- Get contactGETReturns one contact with its account, positions, phone numbers, addresses, tags and custom fields.
- Create contactPOSTCreates a contact, linked to an account with account. Returns the new contact with its id.
- Update contactPUTUpdates the given fields of a contact. archived true archives it.
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.
