CRM Service Calls

Get Deals Created

Changed on

Retrieve deals/opportunities created within a time window (default: last 4 hours).

Returns deals whose timestamp (creation time) falls within the specified date range. If neither start_date nor end_date is provided, defaults to a rolling 4-hour window.

Time-based filtering (start_date / end_date):

  • Format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD
  • Default window (no params): last 4 hours

Example requests:

  • Deals created in the last 4 hours (default): GET /deals/created
  • Deals created in the last 7 days: GET /deals/created?start_date=2026-03-22T00:00:00Z&end_date=2026-03-29T23:59:59Z
  • Discovery-stage deals created this month: GET /deals/created?start_date=2026-03-01&match_filter_dict={"stage": "discovery"}

Other Query Parameters:

  • match_filter_dict (optional): JSON-encoded MongoDB filter for non-date fields. Filterable fields: stage, marketing_source, value_of_sale, account_id, contact_id.

Response: Array of deal objects (same schema as GET /deals).

get/crm/deals/created

Request

Query parameters

match_filter_dictstring
start_datestring nullable

Start of date range in ISO 8601 format. Defaults to now − 4 hours.

end_datestring nullable

End of date range in ISO 8601 format. Defaults to now.

Response

Successful Response

idstring required
namestring required
stagestring required
marketing_sourcestring nullable
agent_namestring nullable
agent_emailstring nullable
agent_phonestring nullable
contact_namestring nullable
contact_emailstring nullable
contact_phonestring nullable
account_namestring nullable
account_emailstring nullable
value_of_salestring nullable
estimated_value_of_salestring nullable
created_datestring nullable
updated_datestring nullable
expected_close_datestring nullable
close_datestring nullable
renewal_datestring nullable

Changes

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the new optional query request parameter end_date

    • info

      added the new optional query request parameter start_date