OBJECT

ActivityEntity

Task or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern.

link GraphQL Schema definition

  • type ActivityEntity {
  • # Values of the record's custom fields as a JSON object keyed by custom field
  • # apiName (camelCase).
  • #
  • # Arguments
  • # apiNames: Api names of custom fields to retrieve. All are
  • # returned if not set.
  • customFields(apiNames: [String!]): JSONString!
  • # Filled only when a single record is read by its id; otherwise null or an empty
  • # list.
  • pendingScheduledActions: Int
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • 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
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Values of the fields shown in the record's preview pane, as configured for the
  • # record's type.
  • #
  • # Arguments
  • # ids: Ids of the fields to return. When not set, the fields
  • # configured for the preview pane of the record's type are returned.
  • # first: Maximum number of preview pane fields to return when ids
  • # is not set; fields pinned by the current user come first.
  • fields(ids: [UUID!], first: Int): [InterfaceFieldData]!
  • }