Filters

Queries

filterDefinitions

Returns the list of available filter keys and their types for a given search context

Arguments

• context (FilterDefinitionContext!) — The search context to get filter definitions for

Returns: [FilterDefinition!]! — Describes an available filter key and its expected type

Objects

FilterDefinition

Describes an available filter key and its expected type

Fields

• key (String!) — The filter key to use in SearchFilterEntryInput
• type (FilterDefinitionType!) — The filter type, corresponds to the field name on SearchFilterEntryInput

Input Objects

AbsoluteDateFilterInput

Fields

• isAllOf ([AbsoluteDateFilterTermInput!])
• isAnyOf ([AbsoluteDateFilterTermInput!])
• isKnown (Boolean)

AbsoluteDateFilterTermInput

Fields

• between ([DateTime!])
• isKnown (Boolean)
• lessThanOrEqualTo (DateTime)
• moreThanOrEqualTo (DateTime)

BooleanFilterInput

Fields

• isAnyOf ([Boolean!])
• isKnown (Boolean)

MoneyFilterInput

Fields

• isAllOf ([MoneyFilterTermInput!])
• isAnyOf ([MoneyFilterTermInput!])
• isKnown (Boolean)

MoneyFilterTermInput

Fields

• between ([MoneyInput!])
• equals (MoneyInput)
• lessThanOrEqualTo (MoneyInput)
• moreThanOrEqualTo (MoneyInput)

NumberFilterInput

Fields

• isAllOf ([NumberFilterTermInput!])
• isAnyOf ([NumberFilterTermInput!])
• isKnown (Boolean)

NumberFilterTermInput

Fields

• between ([Float!])
• equals (Float)
• isKnown (Boolean)
• lessThanOrEqualTo (Float)
• moreThanOrEqualTo (Float)

RecurringDateFilterInput

Fields

• isAllOf ([RecurringDateFilterTermInput!])
• isAnyOf ([RecurringDateFilterTermInput!])
• isKnown (Boolean)

RecurringDateFilterTermInput

Fields

• between ([LocalDate!])
• isKnown (Boolean)
• lessThanOrEqualTo (LocalDate)
• moreThanOrEqualTo (LocalDate)

SearchFilterEntryInput

Fields

• absoluteDateFilter (AbsoluteDateFilterInput)
• booleanFilter (BooleanFilterInput)
• key (String!)
• locationFilter (LocationFilterInput)
• moneyFilter (MoneyFilterInput)
• numberFilter (NumberFilterInput)
• recurringDateFilter (RecurringDateFilterInput)
• stringFilter (StringFilterInput)

SearchFilterInput

Fields

• allOf ([SearchFilterEntryInput!])
• anyOf ([SearchFilterEntryInput!])

ShareFilterGroupInput

A share filter group input to filter a resource

Fields

• allOf ([ShareFilterInput!]) — All of the filters must match
• anyOf ([ShareFilterInput!]) — Any of the filters must match

ShareFilterInput

A share filter input to filter a resource

Fields

• level (ShareLevel!) — The share level to filter by
• role (UserType) — The role to filter by
• teamId (ID) — The Team ID to filter by
• teamsOfUserId (ID) — The User ID to filter Teams that the User is a member of by
• userId (ID) — The User ID to filter by

StringFilterInput

Fields

• containsAllOf ([String!])
• containsAnyOf ([String!])
• containsNoneOf ([String!])
• endsWithAllOf ([String!])
• endsWithAnyOf ([String!])
• endsWithNoneOf ([String!])
• isAllOf ([String!])
• isAnyOf ([String!])
• isKnown (Boolean)
• isNoneOf ([String!])
• startsWithAllOf ([String!])
• startsWithAnyOf ([String!])
• startsWithNoneOf ([String!])

Enums

FilterDefinitionContext

The context for which to retrieve available filter definitions

Values

• APPOINTMENT_EVENTS
• CONVERSATIONS
• DRAFTS
• MARKETING_EVENTS
• MARKETING_SUBSCRIPTIONS
• MESSAGES
• NOTES
• ORDER_ATTRIBUTIONS
• STORIES
• TEMPLATES

FilterDefinitionType

The filter type, corresponds to the field name on SearchFilterEntryInput

Values

• ABSOLUTE_DATE
• BOOLEAN
• LOCATION
• MONEY
• NUMBER
• RECURRING_DATE
• STRING