Filtering
Use thefilters query parameter to narrow results by:
- Lead attributes:
fullName,email,phone,linkedin(supportsvalueorregex) - Campaign:
campaignId(supportsin/outarrays),campaignState(draft, running, ended, paused, errors, archived) - Task properties:
type(manual, phone, email, linkedin, etc.),assignedTo(userId) - Date range:
dueDate(supportsfrom/toin YYYY-MM-DD format)
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Page number for paginated results (0-indexed).
JSON array of filter objects. Each filter has a filterId and specific parameters.
Available Filters:
-
fullName: Filter by contact's full name.- Parameters:
value(string) orregex(string) - Example:
{"filterId":"fullName","value":"John Doe"}
- Parameters:
-
email: Filter by contact's email address.- Parameters:
value(string) orregex(string) - Example:
{"filterId":"email","value":"john@example.com"}
- Parameters:
-
phone: Filter by contact's phone number.- Parameters:
value(string) orregex(string) - Example:
{"filterId":"phone","value":"+1234567890"}
- Parameters:
-
linkedin: Filter by LinkedIn profile URL.- Parameters:
value(string) orregex(string) - Example:
{"filterId":"linkedin","value":"linkedin.com/in/johndoe"}
- Parameters:
-
campaignId: Filter by campaign IDs (inclusion/exclusion).- Parameters:
in(array of strings) and/orout(array of strings) - Example:
{"filterId":"campaignId","in":["cam_123"],"out":["cam_456"]}
- Parameters:
-
campaignState: Filter by campaign states.- Parameters:
in(array of strings) and/orout(array of strings) - Allowed values:
draft,running,ended,paused,errors,archived - Example:
{"filterId":"campaignState","in":["running","paused"]}
- Parameters:
-
type: Filter by task type.- Parameters:
in(array of strings) and/orout(array of strings) - Allowed values:
manual,phone,linkedinInvite,linkedinSend,linkedinVoiceNote,emailsReplied,opportunityReplied,linkedinReplied,opportunityClicked,email,whatsappMessage - Example:
{"filterId":"type","in":["phone","email"]}
- Parameters:
-
assignedTo: Filter by assigned user IDs.- Parameters:
in(array of strings) and/orout(array of strings) - Example:
{"filterId":"assignedTo","in":["usr_123","usr_456"]}
- Parameters:
-
dueDate: Filter by due date range.- Parameters:
from(string, YYYY-MM-DD) and/orto(string, YYYY-MM-DD) - Example:
{"filterId":"dueDate","from":"2025-01-01","to":"2025-12-31"}
- Parameters:
Multiple filters can be combined in an array.