List deals with the Agendor API
Lists and searches the deals of the account, 10 per page by default, in data, with meta.totalCount and the next page in links.next. Each deal brings its status, stage, funnel, owner and the organization or person it belongs to.
- Identifier
- agendor_list_deals
The request
POST https://connect.reportei.com/api/tools/agendor_list_deals/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"title": "<title>"
}
}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 |
|---|---|---|---|
| title | string | No | Beginning of the title. |
| dealStatus | integer | No | Status of the deals: 1 ongoing, 2 won, 3 lost.Values: 1, 2, 3 |
| dealStage | integer | No | Id of a stage, from the dealStages of List funnels. |
| organization | integer | No | Id of an organization, from List organizations. |
| person | integer | No | Id of a person, from List people. |
| userOwner | integer | No | Id of the user who owns the deals, from List users. |
| createdAtGt | string | No | Returns deals created after this date and time, in ISO 8601. |
| updatedAtGt | string | No | Returns deals updated after this date and time, in ISO 8601. |
| endAtGt | string | No | Returns deals finished after this date and time, in ISO 8601. |
| withCustomFields | boolean | No | true includes the custom fields of each deal. |
| page | integer | No | Page number, starting at 1. |
| per_page | integer | No | Deals per page, up to 100. The default is 10. |
Supported connections
Your customer connects their Agendor 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/agendor_list_deals. It becomes your agent's tool definition with no conversion.
Other Agendor tools
- List peopleGETLists and searches the people of the account, 10 per page by default, in data, with meta.totalCount and the next page in links.next. Text filters match the beginning of the value.
- Create personPOSTCreates a person, a contact of an organization in B2B or the customer in B2C, and returns it in data. name is required.
- Update personPUTUpdates the fields sent and returns the person in data. Fields left out keep their values.
- List organizationsGETLists and searches the organizations of the account, the B2B customers, 10 per page by default, in data, with meta.totalCount and the next page in links.next. Text filters match the beginning of the value, except nameExact.
- Create organizationPOSTCreates an organization, a B2B customer, and returns it in data. name is required.
- Update organizationPUTUpdates the fields sent and returns the organization in data. Fields left out keep their values.
- Create organization dealPOSTCreates a deal for an organization, the B2B case, and returns it in data. title is required. Without funnel and dealStage, the deal starts in the first stage of the default funnel.
- Create person dealPOSTCreates a deal for a person, the B2C case, and returns it in data. title is required. Without funnel and dealStage, the deal starts in the first stage of the default funnel.
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.
