Filter

A single filter condition for search operations. Follows HubSpot-compatible structure for familiar CRM integration patterns.

  • field
    Type: string
    required

    The field name to filter on (e.g., "email", "firstName", "tags", "createdUtc"). Must be a valid searchable field for the entity type.

  • operator
    Type: string ยท FilterOperatorenum
    required

    The comparison operator to use for this filter.

    values
    • Eq
    • Ne
    • Gt
    • Gte
    • Lt
  • value
    Type: null | string

    The value to compare against (for single-value operators like eq, contains, gt). Not used for isNull/isNotNull operators or multi-value operators.

  • values
    Type: array string[] | null

    Multiple values for array operators (containsAny, containsAll). Not used for single-value operators.