v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Get Contacts

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

Contacts are qualified individuals who have been converted from leads or added directly. Without filters, returns the most recent contacts sorted by creation date (newest first).

Time-based filtering (start_date / end_date):

Use start_date and end_date query parameters to filter contacts 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 to define the window.
  • Do NOT pass date/timestamp fields inside match_filter_dict — use these parameters instead.

Example requests:

  • All contacts (no date filter): GET /contacts
  • Contacts created in the last 7 days: GET /contacts?start_date=2026-03-22T00:00:00Z&end_date=2026-03-29T23:59:59Z
  • Contacts from referrals created since March 1st: GET /contacts?start_date=2026-03-01&match_filter_dict={"lead_source": "Referral"}

Other Query Parameters:

  • match_filter_dict (optional): JSON-encoded MongoDB query for non-date fields. Filterable fields: status, lead_source, name, email_list, phone_list, tags, employer_name, profession, title.
  • eval_object_id (default: false): Set to true when using ObjectId('...') syntax in filters.
  • sort_dict (default: {"_id": -1}): JSON-encoded sort criteria.
  • page_size (default: 50, max: 500): Number of records per page.

Response: Array of contact objects with id, name, status, marketing_source, contact info, dates, tags, and social profiles.

get/crm/contacts

Query parameters

match_filter_dictstring
eval_object_idboolean
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
first_namestring nullable required
last_namestring nullable required
namestring required
statusstring required
marketing_sourcestring nullable
created_datestring nullable required
updated_datestring nullable required
status_updated_datestring nullable required
tagsstring[] nullable
social_dict_listobject[] nullable