Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Enum

    CustomAttributeType

    Data type of a workspace-defined custom attribute. Determines the value shape and the valid filter operators for conditions on that attribute.

    Values

    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.