v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Get Orders

Retrieve orders with optional filtering, sorting, pagination, and date range.

Returns orders matching your criteria. Without start_date/end_date, returns all matching orders sorted newest first.

Time-based filtering (start_date / end_date):

Use start_date and end_date to filter orders by creation date. Both accept ISO 8601 UTC strings.

  • Format: YYYY-MM-DDTHH:MM:SSZ (full) or YYYY-MM-DD (date only = midnight UTC)
  • Both are optional — provide one or both.
  • Do NOT pass date/timestamp fields inside match_filter_dict — use these parameters instead.

Example requests:

  • All orders (no date filter): GET /orders
  • Orders created in the last 7 days: GET /orders?start_date=2026-03-22T00:00:00Z&end_date=2026-03-29T23:59:59Z
  • Approved orders created this month: GET /orders?start_date=2026-03-01&match_filter_dict={"stage": "approved"}

Other Query Parameters:

  • match_filter_dict (optional): JSON-encoded MongoDB query for non-date fields. Filterable fields: stage, order_type, total_amount, order_date, account_id, contact_id.
  • sort_dict (default: {"_id": -1}): JSON-encoded sort criteria.
  • page_size (default: 50, max: 500): Number of records per page.

Response: Array of order objects with id, name, stage, order_num, order_type, total_amount, order_date, timestamps, account, contact, and opportunity references.

get/crm/orders

Query parameters

match_filter_dictstring
sort_dictstring
page_sizeinteger
start_datestring nullable

Start of date range in ISO 8601 format (e.g. 2026-03-22T00:00:00Z or 2026-03-22). UTC.

Start of date range in ISO 8601 format (e.g. 2026-03-22T00:00:00Z or 2026-03-22). UTC.

end_datestring nullable

End of date range in ISO 8601 format (e.g. 2026-03-29T23:59:59Z or 2026-03-29). UTC.

End of date range in ISO 8601 format (e.g. 2026-03-29T23:59:59Z or 2026-03-29). UTC.

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