v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Get Orders Created

Retrieve orders created within a time window (default: last 4 hours).

Returns orders whose timestamp (creation time) falls within the specified date range. Defaults to a rolling 4-hour window when no dates are provided.

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:

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

Other Query Parameters:

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

Response: Array of order objects (same schema as GET /orders).

get/crm/orders/created

Query parameters

match_filter_dictstring
start_datestring nullable

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

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.

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

Response

Successful Response

idstring required
namestring nullable
stagestring nullable
descriptionstring nullable
order_numstring nullable
order_typestring nullable
order_datestring nullable
total_amountstring nullable
agreement_signed_datestring nullable
created_tsstring nullable
created_ts_datestring nullable
updated_tsstring nullable
updated_ts_datestring nullable
accountstring nullable
primary_sales_agent_emailstring nullable
contactstring nullable
opportunitystring nullable