Page number for pagination (starting from 1). Use this with limit to navigate through large result sets.
limitinteger
Maximum number of contacts to return per page (1-250). Default is 250 if not specified.
query
Search query to filter contacts. Searches across contact custom field values (e.g., phone numbers, emails, names). Can be a string or integer.
filter_idsarray
Filter to return only contacts with specific IDs. Provide a list of contact IDs to retrieve.
order_by_idstring
Sort contacts by ID. Valid values: 'asc' (lowest ID first), 'desc' (highest ID first).
with_paramsarray
Additional embedded data to include in response. Supported values: 'leads' (include linked leads), 'catalog_elements' (include linked catalog items). Multiple values can be provided as a list.
filter_namesarray
Filter to return only contacts with specific names. Provide a list of exact name strings to match.
filter_created_atinteger
Filter to return only contacts created at or after this Unix timestamp. Used to find contacts created from a specific time onwards.
filter_created_byarray
Filter to return only contacts created by specific users. Provide a list of user IDs.
filter_updated_atobject
Model for date range filters in Unix timestamp format.
filter_updated_byarray
Filter to return only contacts last updated by specific users. Provide a list of user IDs.
order_by_updated_atstring
Sort contacts by last update timestamp. Valid values: 'asc' (oldest first), 'desc' (newest first).
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not