Skip to main content

CRM

These read-only tools expose the contact database for a funnel. Use them to inspect leads captured by a funnel, build informed filter conditions for email sequences, or surface contact data in a conversational interface.

get_crm_properties is particularly useful before building a filter step in a sequence: it returns the exact fieldName and fieldType values you need to reference in filter conditions. Find funnel IDs with list_workspaces.

Tools

ToolPurposeKey inputsReturns
list_contactsList CRM contacts for a funnel with pagination and sortingfunnelId, limit, page, sortField, sortOrderPaginated contacts array + pagination meta
get_contactGet full details for a single contactfunnelId, contactIdContact object
get_crm_propertiesGet the contact field schema for a funnelfunnelIdArray of { fieldName, fieldType, title? }

list_contacts inputs

NameTypeRequiredDescription
funnelIdstringYesFunnel ID — 24-character hex string
limitnumberNoContacts per page, 1–100; default 50
pagenumberNo0-based page number; default 0
sortFieldstringNoField to sort by: ps_converted_at (default), email, firstName, lastName
sortOrder"-1" | "1"No-1 for newest first (default), 1 for oldest first

get_contact inputs

NameTypeRequiredDescription
funnelIdstringYesFunnel ID — 24-character hex string
contactIdstringYesContact ID — 24-character hex string

get_crm_properties inputs

NameTypeRequiredDescription
funnelIdstringYesFunnel ID — 24-character hex string

Returns { data: Array<{ fieldName, fieldType, title? }> }. Use fieldName values as the fieldName key in sequence filter step conditions.