Input object

CustomAttributeConditionInput

A single filter condition on a workspace-defined custom attribute. Multiple conditions are combined with AND.

Fields

Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

field String! required: Key of the custom attribute to filter on, as returned by customAttributeSchemas (e.g. "sentiment").
operator FilterOperator! required: Comparison operator. The valid set depends on the attribute type; see FilterOperator.
BETWEEN: Inclusive range match for number and date types; value is { from, to }.
CONTAINS: For text-like types: substring match. For multi-select and list types: matches records containing ANY of the provided values (OR semantics).
CONTAINS_ALL: For multi-select custom attributes: matches records whose value array contains ALL of the provided values (AND semantics).
DOES_NOT_CONTAIN: For text-like types: excludes substring matches. For multi-select and list types: excludes records containing any of the provided values.
ENDS_WITH: Suffix match, for text-like types.
EQUAL: Equality, for number and date types.
IS: Exact match. For text and single-select types (for selects, value is the option ID) and BOOLEAN (value is true/false).
IS_EMPTY: Matches records with no value set. Value is ignored; pass null.
IS_NOT: Exact non-match, for text and single-select types.
IS_NOT_EMPTY: Matches records with any value set. Value is ignored; pass null.
IS_RELATIVE_TO_TODAY: Matches date values in a period relative to today; value is { relation: "past"|"this"|"next", period: "day"|"week"|"month"|"year" } (offset optional).
LESS_THAN: Strictly less than, for number and date types.
LESS_THAN_OR_EQUAL: Less than or equal, for number and date types.
MORE_THAN: Strictly greater than, for number and date types.
MORE_THAN_OR_EQUAL: Greater than or equal, for number and date types.
NOT_EQUAL: Inequality, for number and date types.
STARTS_WITH: Prefix match, for text-like types.
type CustomAttributeType! required: Type of the custom attribute, as returned by customAttributeSchemas. Determines the expected value shape and the valid operators.
BOOLEAN: True/false value.
BOOLEAN_LIST: List of true/false values.
DATE: Calendar date value (ISO 8601, no time component).
DATETIME: Date-and-time value (ISO 8601).
DATETIME_LIST: List of date-and-time values (ISO 8601).
DATE_LIST: List of calendar date values (ISO 8601, no time component).
EMAIL: Email address value.
MULTIPLE_SELECT: Multiple choices from a predefined option list; the stored value is an array of option IDs.
MULTIPLE_SELECT_V2: Multiple choices from a predefined option list; the stored value is an array of option IDs. Successor revision of MULTIPLE_SELECT with identical filtering behavior.
NUMBER: Numeric value.
NUMBER_LIST: List of numeric values.
PHONE: Phone number value.
SHIPPING_ADDRESS: Structured shipping address. Not filterable: conditions with this type are rejected with a validation error; read the value from the record's customAttributes instead.
SINGLE_SELECT_V2: Single choice from a predefined option list; the stored value is an option ID.
SINGLE_SELECT_V3: Single choice from a predefined option list; the stored value is an option ID. Successor revision of SINGLE_SELECT_V2 with identical filtering behavior.
TEXT: Free-form text value.
TEXT_LIST: List of free-form text values.
URL: URL value.
value JSON: Comparison value; the shape depends on type: a string for text-like types, an option ID for single-selects, a number for NUMBER, an ISO 8601 string for dates, true/false for BOOLEAN, an array for multi-select and list types. BETWEEN takes { from, to }. Pass null for IS_EMPTY / IS_NOT_EMPTY.