OBJECT
AppointmentEntity

GraphQL Schema definition

type AppointmentEntity {
# Arguments
#   apiNames: Api names of custom fields to retrieve. All are 
#   returned if not set.
customFields(apiNames: [String!]): JSONString! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
pendingScheduledActions: Int 
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
isDeleteProtected: Boolean! 
#   Unique identifier of entity.
id: ID! 
#   Timestamp of the next pending reminder configured for the activity (reminder 
#   time, due date or end date as applicable). Empty when no reminder is pending.
activeReminder: String 
#   Id of the linked Media record holding the activity's call recording / 
#   transcription, when available.
mediaTranscriptionId: UUID 
#   Specifies if the entity is considered deleted.
isDeleted: Boolean 
#   Last modification time.
modified: DateTime 
#   Creation time.
created: DateTime 
#   Appointment type that classifies this appointment. Drives form layout and icon.
activityType: AppointmentTypeEntity 
#   Currency exchange rate list used to convert monetary fields linked to this 
#   appointment. Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
#   Sales user who owns this appointment.
owner: ClientEntity 
#   Master appointment of the recurring series this occurrence belongs to. Empty for 
#   standalone appointments and for the master itself.
recurrenceMaster: AppointmentEntity 
#   Appointment schedule (booking link) this appointment was created through, or 
#   empty for appointments created directly.
schedule: AppointmentScheduleEntity 
#   Sales unit this appointment is assigned to. Determines which team members can 
#   see the record under unit-based sharing.
unit: SalesUnitEntity 
#   Id of the appointment type.
activityTypeId: ID 
#   Id of the currency exchange rate list applied to this appointment.
currencyExchangeRatesListId: ID 
#   Free-form description of the appointment.
description: String 
#   Duration of the appointment, derived from start/end dates.
duration: Float 
#   End timestamp of the appointment.
endDate: DateTime! 
#   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: String 
#   Online meeting link associated with the appointment (join URL plus meeting type, 
#   e.g. Zoom, Teams). Empty when the appointment has no online meeting attached.
meetingUrl: AppointmentMeeting 
#   Original date of this occurrence in the recurring series. Set automatically.
occurenceDate: DateTime 
#   Email of the user organising the appointment. Set automatically and used as the 
#   reply-to address in invitation emails.
organizer: String 
#   Id of the appointment owner.
ownerId: ID! 
#   Id of the master appointment.
recurrenceMasterId: ID 
#   iCalendar RRULE string describing the recurrence pattern (e.g. 
#   "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments.
recurrenceRule: String 
#   IANA timezone the recurrence rule is evaluated in.
recurrenceTzid: String 
#   Id of the appointment schedule.
scheduleId: ID 
#   IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to 
#   evaluate availability against the schedule.
scheduleTzid: String 
#   Start timestamp of the appointment.
startDate: DateTime 
#   Short summary line shown in calendars and lists.
subject: String! 
#   Discriminator identifying the concrete record type — always "appointment" for 
#   Appointment records. Read-only; useful when consuming polymorphic Activity 
#   results.
tableName: String! 
#   Id of the sales unit.
unitId: ID 
#   Revision when entity was lastly changed.
revision: Int 
#   Current status of the appointment (NotStarted, InProgress, Completed, Canceled). 
#   Read-only; derived from the start/end times and the deleted flag.
status: ActivityStatusEnum! 
#   Accounts this appointment is linked to.
# 
# Arguments
#   filter: Filter Account relations by target Account attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order Account relations by target Account attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
accountRelations(
filter: AccountFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [AccountOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Contacts this appointment is linked to.
# 
# Arguments
#   filter: Filter Contact relations by target Contact attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order Contact relations by target Contact attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
contactRelations(
filter: ContactFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Leads this appointment is linked to.
# 
# Arguments
#   filter: Filter Lead relations by target Lead attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order Lead relations by target Lead attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
leadRelations(
filter: LeadFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [LeadOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Opportunities this appointment is linked to.
# 
# Arguments
#   filter: Filter Opportunity relations by target Opportunity 
#   attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order Opportunity relations by target Opportunity 
#   attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
opportunityRelations(
filter: OpportunityFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [OpportunityOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Projects this appointment is linked to, including the per-objective ordering.
# 
# Arguments
#   filter: Filter Project relations by target Project attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order Project relations by target Project attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
projectRelations(
filter: ProjectFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [ProjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Quotes this appointment is linked to.
# 
# Arguments
#   filter: Filter Quote relations by target Quote attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order Quote relations by target Quote attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
quoteRelations(
filter: QuoteFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [QuoteOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Custom entity records this appointment is linked to.
# 
# Arguments
#   filter: Filter CustomEntity relations by target CustomEntity 
#   attributes.
#   filterEdge: Filter ActivityRelation relations by edge 
#   (relation) ActivityRelation attributes.
#   orderBy: Order CustomEntity relations by target CustomEntity 
#   attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
customEntityRelations(
filter: CustomEntityFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [CustomEntityOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
#   Non-user invitees on this appointment, identified by email. Contacts are 
#   auto-linked when their email matches an existing Contact record.
# 
# Arguments
#   filter: Filter AppointmentContactInviteesRelation relations by 
#   target AppointmentContactInviteesRelation attributes.
#   orderBy: Order AppointmentContactInviteesRelation relations by 
#   target AppointmentContactInviteesRelation attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
inviteesContacts(
filter: AppointmentContactInviteesRelationFilterInput,
orderBy: [AppointmentContactInviteesRelationOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): AppointmentContactInviteesRelationEntityConnection 
#   Internal-user invitees on this appointment.
# 
# Arguments
#   filter: Filter Client relations by target Client attributes.
#   filterEdge: Filter AppointmentClientInviteesRelation relations 
#   by edge (relation) AppointmentClientInviteesRelation attributes.
#   orderBy: Order Client relations by target Client attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
inviteesClients(
filter: ClientFilterInput,
filterEdge: AppointmentClientInviteesRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): AppointmentClientInviteesRelationEntityConnection 
#   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 
#   True when this appointment is mirrored to an external calendar (Office 365, 
#   Exchange, Google). Read-only.
has3rdPartyMapping: Boolean! 
reminder: AppointmentReminderEntity 
#   Documents linked to this appointment.
# 
# Arguments
#   filter: Filter CloudObject relations by target CloudObject 
#   attributes.
#   filterEdge: Filter CloudObjectRelation relations by edge 
#   (relation) CloudObjectRelation attributes.
#   orderBy: Order CloudObject relations by target CloudObject 
#   attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
documents(
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
#   Comments authored on this appointment.
# 
# Arguments
#   filter: Filter ActivityComment relations by target 
#   ActivityComment attributes.
#   orderBy: Order ActivityComment relations by target 
#   ActivityComment attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
comments(
filter: ActivityCommentFilterInput,
orderBy: [ActivityCommentOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityCommentEntityConnection 
#   Tag labels applied to this appointment.
# 
# Arguments
#   filter: Filter Tag relations by target Tag attributes.
#   filterEdge: Filter TagRelation relations by edge (relation) 
#   TagRelation attributes.
#   orderBy: Order Tag relations by target Tag attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
tags(
filter: TagFilterInput,
filterEdge: TagRelationFilterInput,
orderBy: [TagOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TagRelationEntityConnection 
#   Display name of the appointment (alias of subject).
formattedName: String! 
#   Recurrence configuration for recurring appointments (parsed RRULE plus exception 
#   metadata). Empty for one-off appointments.
recurrence: AppointmentRecurrence 
#   Timestamp of the most recent modification made by an end user (excluding system 
#   changes). Read-only; computed by Coevera.
modifiedByUser: DateTime 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Arguments
#   entityType: [Not documented]
relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel! 
# Arguments
#   ids: [Not documented]
charts(ids: [UUID!]!): [DashboardChartData!] 
# Arguments
#   id: [Not documented]
#   seriesIndex: [Not documented]
#   itemIndex: [Not documented]
chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel! 
# Arguments
#   ids: Null to load all fields defined on InterfacePreview entity
#   first: [Not documented]
fields(ids: [UUID!], first: Int): [InterfaceFieldData]! 
mediaTranscription: MediaEntity 
}
AppointmentEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
