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.
Request
- Base URLhttps://fapi.ambivo.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Start of date range in ISO 8601 format (e.g. 2026-03-22T00:00:00Z or 2026-03-22). UTC.
End of date range in ISO 8601 format (e.g. 2026-03-29T23:59:59Z or 2026-03-29). UTC.
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.