Activity Search
activity_searchFull Description
Search for activities. Results are returned ordered by date descending.
Examples:
- To list activities on a lead, use the lead_ids filter.
- To list conversations, filter for calls and meetings.
- Filter for Email to get individual messages, or EmailThread to get one
result per conversation. An unfiltered search returns both.
Parameters (0 required, 10 optional)
activity_atobjectFilter activities by timestamp. For EmailThread, this is the timestamp of its most recent email.
nullactivity_typesarraynullagent_config_idsarrayFilter by voice agent config IDs. Matches Call, Email, and SMS activities that carry an agent_config_id; other activity types are filtered out implicitly because the field is not indexed for them.
nullcall_statusstringFilter calls by status (e.g. completed, no-answer, busy). Only meaningful when activity_types includes Call; a no-op unless Call is searched. Other activity types use different status vocabularies, so they never match these values and are effectively excluded.
nullcontact_idsarraynullcursorstringPagination cursor, give only when more results are requested.
nulldirectionstringFilter activities by direction (inbound = received by the user, outbound = sent by the user). Applies to Call, SMS, Email, and WhatsApp activities; activity types that have no direction (e.g. Note, Task) are excluded when this filter is set.
nulllead_idsarraynulllead_smart_view_idsarraynulluser_idsarraynull