INPUT_OBJECT

AppointmentFilterInput

Filter conditions for Appointment records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input AppointmentFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [AppointmentFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [AppointmentFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: AppointmentFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Id of the appointment type.
  • activityTypeId: EntityFilterStringField
  • # Id of the currency exchange rate list applied to this appointment.
  • currencyExchangeRatesListId: EntityFilterStringField
  • # Free-form description of the appointment.
  • description: EntityFilterStringField
  • # Duration of the appointment, derived from start/end dates.
  • duration: EntityFilterNumberField
  • # End timestamp of the appointment.
  • endDate: EntityFilterDateTimeField
  • # True when invitees are allowed to edit the appointment. Defaults to false.
  • inviteesCanEdit: Boolean
  • # True when the recurrence series is still generating new occurrences. Read-only.
  • isRecurrenceActive: Boolean
  • # True when this occurrence has been modified independently of the recurring
  • # series. Read-only.
  • isRecurrenceException: Boolean
  • # Free-text physical location of the appointment.
  • location: EntityFilterStringField
  • # Original date of this occurrence in the recurring series. Set automatically.
  • occurenceDate: EntityFilterDateTimeField
  • # Email of the user organising the appointment. Set automatically and used as the
  • # reply-to address in invitation emails.
  • organizer: EntityFilterStringField
  • # Id of the appointment owner.
  • ownerId: EntityFilterStringField
  • # Id of the master appointment.
  • recurrenceMasterId: EntityFilterStringField
  • # iCalendar RRULE string describing the recurrence pattern (e.g.
  • # "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments.
  • recurrenceRule: EntityFilterStringField
  • # IANA timezone the recurrence rule is evaluated in.
  • recurrenceTzid: EntityFilterStringField
  • # Id of the appointment schedule.
  • scheduleId: EntityFilterStringField
  • # IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to
  • # evaluate availability against the schedule.
  • scheduleTzid: EntityFilterStringField
  • # Start timestamp of the appointment.
  • startDate: EntityFilterDateTimeField
  • # Short summary line shown in calendars and lists.
  • subject: EntityFilterStringField
  • # Discriminator identifying the concrete record type — always "appointment" for
  • # Appointment records. Read-only; useful when consuming polymorphic Activity
  • # results.
  • tableName: EntityFilterStringField
  • # Id of the sales unit.
  • unitId: EntityFilterStringField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Current status of the appointment (NotStarted, InProgress, Completed, Canceled).
  • # Read-only; derived from the start/end times and the deleted flag.
  • status: ActivityStatusEnumFilterInput
  • # External identifier of the record in the linked third-party service (e.g.
  • # Google, Microsoft 365, Exchange). Maintained by the sync engine.
  • exchangeEntityId: String
  • # External identifier of the record in the linked third-party service (e.g.
  • # Google, Microsoft 365, Exchange). Maintained by the sync engine.
  • gapiEntityId: String
  • # External identifier of the record in the linked third-party service (e.g.
  • # Google, Microsoft 365, Exchange). Maintained by the sync engine.
  • o365EntityId: String
  • # Conditions on custom fields, each identified by its api name. All listed
  • # conditions must match.
  • withCustom: [CustomField!]
  • # Appointment type that classifies this appointment. Drives form layout and icon.
  • # Matches records where a related record meets these conditions.
  • activityType: AppointmentTypeFilterInput
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # appointment. Empty to inherit the team space default. Matches records where a
  • # related record meets these conditions.
  • currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput
  • # Sales user who owns this appointment. Matches records where a related record
  • # meets these conditions.
  • owner: ClientFilterInput
  • # Master appointment of the recurring series this occurrence belongs to. Empty for
  • # standalone appointments and for the master itself. Matches records where a
  • # related record meets these conditions.
  • recurrenceMaster: AppointmentFilterInput
  • # Appointment schedule (booking link) this appointment was created through, or
  • # empty for appointments created directly. Matches records where a related record
  • # meets these conditions.
  • schedule: AppointmentScheduleFilterInput
  • # Sales unit this appointment is assigned to. Determines which team members can
  • # see the record under unit-based sharing. Matches records where a related record
  • # meets these conditions.
  • unit: SalesUnitFilterInput
  • # Accounts this appointment is linked to. Matches records where a related record
  • # meets these conditions.
  • accountRelations: ActivityRelationFilterInput
  • # Contacts this appointment is linked to. Matches records where a related record
  • # meets these conditions.
  • contactRelations: ActivityRelationFilterInput
  • # Leads this appointment is linked to. Matches records where a related record
  • # meets these conditions.
  • leadRelations: ActivityRelationFilterInput
  • # Opportunities this appointment is linked to. Matches records where a related
  • # record meets these conditions.
  • opportunityRelations: ActivityRelationFilterInput
  • # Projects this appointment is linked to, including the per-objective ordering.
  • # Matches records where a related record meets these conditions.
  • projectRelations: ActivityRelationFilterInput
  • # Quotes this appointment is linked to. Matches records where a related record
  • # meets these conditions.
  • quoteRelations: ActivityRelationFilterInput
  • # Custom entity records this appointment is linked to. Matches records where a
  • # related record meets these conditions.
  • customEntityRelations: ActivityRelationFilterInput
  • # Non-user invitees on this appointment, identified by email. Contacts are
  • # auto-linked when their email matches an existing Contact record. Matches records
  • # where a related record meets these conditions.
  • inviteesContacts: AppointmentContactInviteesRelationFilterInput
  • # Internal-user invitees on this appointment. Matches records where a related
  • # record meets these conditions.
  • inviteesClients: AppointmentClientInviteesRelationFilterInput
  • # Reminder set by the current authenticated user for this appointment. Per-user;
  • # empty when no reminder has been set. Matches records where a related record
  • # meets these conditions.
  • reminder: AppointmentReminderFilterInput
  • # Documents linked to this appointment. Matches records where a related record
  • # meets these conditions.
  • documents: CloudObjectRelationFilterInput
  • # Comments authored on this appointment. Matches records where a related record
  • # meets these conditions.
  • comments: ActivityCommentFilterInput
  • # Tag labels applied to this appointment. Matches records where a related record
  • # meets these conditions.
  • tags: TagRelationFilterInput
  • }

link Require by