Deals

get_deals

Get list of deals for the authenticated user's organization

get_deals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deals",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "stage": "LEAD",
        "clientId": "550e8400-e29b-41d4-a716-446655440000",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_deals",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "stage": "LEAD",
    "clientId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_deals", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "stage": "LEAD",
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for deal title

relationsArray<string>

Relations to include (e.g., ["client", "createdByUser"])

stagestringLEADQUALIFIED_LEADPROPOSAL_MADENEGOTIATIONCLOSED_WONCLOSED_LOST

Filter by deal stage

clientIdstring<uuid>

Filter by client ID

createdByUserIdstring<uuid>

Filter by creator user ID

get_deal_count

Get deal count in the authenticated user's organization

get_deal_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deal_count",
    "arguments": {
        "stage": "LEAD",
        "clientId": "550e8400-e29b-41d4-a716-446655440000",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_deal_count",
  "arguments": {
    "stage": "LEAD",
    "clientId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_deal_count", arguments={
  "stage": "LEAD",
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

stagestringLEADQUALIFIED_LEADPROPOSAL_MADENEGOTIATIONCLOSED_WONCLOSED_LOST

Filter by deal stage

clientIdstring<uuid>

Filter by client ID

createdByUserIdstring<uuid>

Filter by creator user ID

get_deal

Get a specific deal by ID

get_deal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deal",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_deal",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_deal", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The deal ID

relationsArray<string>

Relations to include (e.g., ["client", "createdByUser", "properties"])

create_deal

Create a new deal in the authenticated user's organization

create_deal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_deal",
    "arguments": {
        "deal_data": {
          "title": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_deal",
  "arguments": {
    "deal_data": {
      "title": "string"
    }
  }
});

result = await session.call_tool("create_deal", arguments={
  "deal_data": {
    "title": "string"
  }
})

Request Body

{
  "deal_data": {
    "title": "string"
  }
}

Body

application/json

deal_dataobjectrequired

The data for creating the deal

Show child attributes

titlestringrequired

The title (required)

[key: string]any

update_deal

Update an existing deal

update_deal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_deal",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "deal_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_deal",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "deal_data": {}
  }
});

result = await session.call_tool("update_deal", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "deal_data": {}
})

Parameters

idstring<uuid>required

The deal ID

deal_dataobjectrequired

The data for updating the deal

update_deal_stage

Update the stage of a deal

update_deal_stage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_deal_stage",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "stage": "LEAD"
      }
  }
}

const result = await client.callTool({
  "name": "update_deal_stage",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "stage": "LEAD"
  }
});

result = await session.call_tool("update_deal_stage", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "stage": "LEAD"
})

Parameters

idstring<uuid>required

The deal ID

stagestringLEADQUALIFIED_LEADPROPOSAL_MADENEGOTIATIONCLOSED_WONCLOSED_LOSTrequired

The new stage for the deal

delete_deal

Delete a deal

delete_deal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_deal",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_deal",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_deal", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The deal ID

get_deals_by_client

Get deals for a specific client

get_deals_by_client

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deals_by_client",
    "arguments": {
        "clientId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "stage": "LEAD",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_deals_by_client",
  "arguments": {
    "clientId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "stage": "LEAD",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_deals_by_client", arguments={
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "stage": "LEAD",
  "relations": [
    "string"
  ]
})

Parameters

clientIdstring<uuid>required

The client ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

stagestringLEADQUALIFIED_LEADPROPOSAL_MADENEGOTIATIONCLOSED_WONCLOSED_LOST

Filter by deal stage

relationsArray<string>

Relations to include

get_my_deals

Get deals created by the current authenticated user

get_my_deals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_deals",
    "arguments": {
        "page": 1,
        "limit": 10,
        "stage": "LEAD",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_my_deals",
  "arguments": {
    "page": 1,
    "limit": 10,
    "stage": "LEAD",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_my_deals", arguments={
  "page": 1,
  "limit": 10,
  "stage": "LEAD",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

stagestringLEADQUALIFIED_LEADPROPOSAL_MADENEGOTIATIONCLOSED_WONCLOSED_LOST

Filter by deal stage

relationsArray<string>

Relations to include

get_deal_statistics

Get deal statistics for the authenticated user's organization

get_deal_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deal_statistics",
    "arguments": {
        "clientId": "550e8400-e29b-41d4-a716-446655440000",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_deal_statistics",
  "arguments": {
    "clientId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_deal_statistics", arguments={
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "string",
  "endDate": "string"
})

Parameters

clientIdstring<uuid>

Filter by specific client ID

createdByUserIdstring<uuid>

Filter by creator user ID

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

add_deal_property

Add a custom property to a deal

add_deal_property

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_deal_property",
    "arguments": {
        "dealId": "550e8400-e29b-41d4-a716-446655440000",
        "property": {
          "name": "string",
          "value": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "add_deal_property",
  "arguments": {
    "dealId": "550e8400-e29b-41d4-a716-446655440000",
    "property": {
      "name": "string",
      "value": "string"
    }
  }
});

result = await session.call_tool("add_deal_property", arguments={
  "dealId": "550e8400-e29b-41d4-a716-446655440000",
  "property": {
    "name": "string",
    "value": "string"
  }
})

Request Body

{
  "dealId": "550e8400-e29b-41d4-a716-446655440000",
  "property": {
    "name": "string",
    "value": "string"
  }
}

Body

application/json

dealIdstring<uuid>required

The deal ID

propertyobjectrequired

The property to add

Show child attributes

namestringrequired

Property name

valuestringrequired

Property value

update_deal_property

Update a custom property of a deal

update_deal_property

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_deal_property",
    "arguments": {
        "dealId": "550e8400-e29b-41d4-a716-446655440000",
        "propertyName": "string",
        "value": "string"
      }
  }
}

const result = await client.callTool({
  "name": "update_deal_property",
  "arguments": {
    "dealId": "550e8400-e29b-41d4-a716-446655440000",
    "propertyName": "string",
    "value": "string"
  }
});

result = await session.call_tool("update_deal_property", arguments={
  "dealId": "550e8400-e29b-41d4-a716-446655440000",
  "propertyName": "string",
  "value": "string"
})

Parameters

dealIdstring<uuid>required

The deal ID

propertyNamestringrequired

The property name to update

valuestringrequired

The new property value

remove_deal_property

Remove a custom property from a deal

remove_deal_property

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_deal_property",
    "arguments": {
        "dealId": "550e8400-e29b-41d4-a716-446655440000",
        "propertyName": "string"
      }
  }
}

const result = await client.callTool({
  "name": "remove_deal_property",
  "arguments": {
    "dealId": "550e8400-e29b-41d4-a716-446655440000",
    "propertyName": "string"
  }
});

result = await session.call_tool("remove_deal_property", arguments={
  "dealId": "550e8400-e29b-41d4-a716-446655440000",
  "propertyName": "string"
})

Parameters

dealIdstring<uuid>required

The deal ID

propertyNamestringrequired

The property name to remove

get_deals_pipeline

Get deals organized by pipeline stages for the authenticated user's organization

get_deals_pipeline

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deals_pipeline",
    "arguments": {
        "clientId": "550e8400-e29b-41d4-a716-446655440000",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_deals_pipeline",
  "arguments": {
    "clientId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_deals_pipeline", arguments={
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

clientIdstring<uuid>

Filter by client ID

createdByUserIdstring<uuid>

Filter by creator user ID

search_deals

Search deals by title or properties

search_deals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_deals",
    "arguments": {
        "query": "string",
        "limit": 20,
        "stage": "LEAD",
        "clientId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "search_deals",
  "arguments": {
    "query": "string",
    "limit": 20,
    "stage": "LEAD",
    "clientId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("search_deals", arguments={
  "query": "string",
  "limit": 20,
  "stage": "LEAD",
  "clientId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

querystringrequired

Search query

limitnumber20

Maximum number of results

stagestringLEADQUALIFIED_LEADPROPOSAL_MADENEGOTIATIONCLOSED_WONCLOSED_LOST

Filter by deal stage

clientIdstring<uuid>

Filter by client ID

Stack Overflow Website Demo