Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.
TypeScript agentaiai-agentsall-in-onecrmcrm-systememaillinearmcpmessagingnotesnotionofficerustslackslack-alternativestartupstartup-toolstypescriptworkspace
"""
Page request for the authenticated user's activity feed.
"""
input ActivityFeedInput {
"""
Opaque cursor from the previous page's `nextCursor`; absent for the
first page. Pass it back with the same `scope`.
"""
cursor: String
"""
Page size; defaults to 25, capped at 100.
"""
limit: Int
"""
Whose activity to read; defaults to the user's own.
"""
scope: ActivityFeedScope! = MINE
}
"""
Whose activity an activity feed page reads.
"""
enum ActivityFeedScope {
"""
The authenticated user's own activity, delegated actions included.
"""
MINE
"""
Activity by the authenticated user's teammates, on entities shared
with the user (link sharing alone does not count; forms never). A
page may hold fewer items than its limit, or none, while
`nextCursor` is set: keep paging until it is absent.
"""
TEAM
}
"""
Request for the authenticated user's trailing-year activity overview.
"""
input ActivityOverviewInput {
"""
IANA time zone used for local dates. Omitted or empty means UTC.
"""
timeZone: String
}
"""
An all-day span with an exclusive end date.
"""
input AllDayEventTimeInput {
"""
Inclusive local start date (`YYYY-MM-DD`).
"""
startDate: String!
"""
Exclusive local end date (`YYYY-MM-DD`).
"""
endDate: String!
}
"""
An attendee to invite.
"""
input CalendarAttendeeInput {
"""
Attendee email address.
"""
email: String!
"""
Whether attendance is optional.
"""
isOptional: Boolean! = false
}
"""
A request for calendar changes after a watermark.
"""
input CalendarChangesInput {
"""
The client's watermark, one entry per tracked connected inbox. Empty
returns only the current watermark.
"""
since: [CalendarLinkWatermarkInput!]!
}
"""
The time shape of an event.
"""
input CalendarEventTimeInput @oneOf {
"""
A span with absolute instants.
"""
timed: TimedEventTimeInput
"""
An all-day span.
"""
allDay: AllDayEventTimeInput
}
"""
A guest to add to an event.
"""
input CalendarGuestInput {
"""
Guest email address.
"""
email: String!
"""
Whether attendance is optional.
"""
optional: Boolean! = false
}
"""
What guests may do with an event; Google calendars only.
"""
input CalendarGuestPolicyInput {
"""
Whether guests may change the event; implies inviting others.
"""
canModify: Boolean!
"""
Whether guests may invite others.
"""
canInviteOthers: Boolean!
"""
Whether guests may see the guest list.
"""
canSeeOtherGuests: Boolean!
}
"""
How far the client has applied one connected inbox's change log.
"""
input CalendarLinkWatermarkInput {
"""
Connected inbox identifier.
"""
linkId: ID!
"""
Last applied sequence, as the decimal string the server returned.
"""
seq: String!
}
"""
Out-of-office properties. Present to create or edit an out-of-office
status event.
"""
input CalendarOutOfOfficeInput {
"""
How conflicting invitations are handled while the user is out.
"""
autoDeclineMode: GraphqlCalendarOutOfOfficeAutoDeclineMode! = DECLINE_NONE
"""
Message returned to organizers whose invitations are auto-declined.
"""
declineMessage: String
}
"""
A bounded occurrence viewport and page request.
"""
input CalendarRangeInput {
"""
Inclusive UTC viewport start in RFC 3339 format.
"""
start: String!
"""
Exclusive UTC viewport end in RFC 3339 format.
"""
end: String!
"""
Inclusive local date boundary for all-day events (`YYYY-MM-DD`).
Defaults to the date of `start`.
"""
startDate: String
"""
Exclusive local date boundary for all-day events (`YYYY-MM-DD`).
Defaults to the first date at or after `end`.
"""
endDate: String
"""
Page size, from 1 through 2,000. Defaults to 1,000.
"""
first: Int
"""
`endCursor` of the previous page.
"""
after: String
}
"""
One reminder.
"""
input CalendarReminderOverrideInput {
"""
Delivery method (`popup` or `email`).
"""
method: String!
"""
Minutes before the start the reminder fires.
"""
minutes: Int!
}
"""
An event's reminder configuration.
"""
input CalendarRemindersInput {
"""
Whether the calendar's default reminders apply.
"""
useDefault: Boolean!
"""
Explicit reminders, used when `useDefault` is false.
"""
overrides: [CalendarReminderOverrideInput!]! = []
}
"""
Channel activity operation exposed by GraphQL.
"""
enum ChannelActivityType {
"""
Record that the user viewed the channel.
"""
VIEW
"""
Record that the user interacted with the channel.
"""
INTERACT
}
"""
Channel-specific entry inside the otherwise common share-policy model.
"""
input ChannelSharePolicyInput {
"""
Requested change.
"""
operation: GraphqlSharePolicyOperation!
"""
Channel receiving or losing access.
"""
channelId: ID!
"""
Access level for add/replace operations.
"""
accessLevel: GraphqlEntityAccessLevel
}
"""
One batch of clearing the viewer's notification inbox.
"""
input ClearNotificationInboxInput {
"""
Which rows are cleared; the inbox the caller shows.
"""
scope: NotificationInboxScopeInput
"""
Clear only unread rows.
"""
unreadOnly: Boolean @deprecated(reason: "Set scope.unreadOnly. Remove after 2026-12-06.")
"""
RFC 3339 time; clear only rows whose newest notification arrived at or
after it.
"""
since: String
"""
Groups read in this batch; defaults to 100, capped at 200.
"""
limit: Int
"""
Opaque cursor from the previous batch's `nextCursor`; absent for the
first. Send it with the same scope, filters and `since`.
"""
cursor: String
}
"""
The result of one batch of clearing the inbox.
"""
type ClearNotificationInboxPayload {
"""
How many rows the batch cleared.
"""
rowCount: Int!
"""
Opaque token that reverses exactly this batch.
"""
undoToken: String!
"""
Send as the next batch's `cursor` to keep clearing; absent once
nothing is left.
"""
nextCursor: String
}
"""
Mutation root combining independent domain GraphQL adapters.
"""
type CompleteMutationRoot {
"""
Remove a property assignment and identify its normalized cache record.
"""
deleteEntityProperty(entityType: GraphqlPropertyTargetEntityType!, entityId: String!, entityPropertyId: ID!): GraphqlCacheDeletion!
"""
Set or attach one property on an entity.
"""
setEntityProperty(input: SetEntityPropertyInput!): GraphqlProperty!
"""
Add and remove options across one entity's multi-select properties.
"""
updateEntityPropertyOptions(input: UpdateEntityPropertyOptionsInput!): [GraphqlProperty!]!
"""
Rename heterogeneous entities in one request.
"""
renameEntities(inputs: [RenameEntityInput!]!): EntityMutationPayload!
"""
Move heterogeneous entities to a project or to the root.
"""
moveEntities(inputs: [MoveEntityInput!]!): EntityMutationPayload!
"""
Update link, explicit team, and channel share policies across supported entity kinds.
"""
updateEntitySharePolicies(inputs: [UpdateEntitySharePolicyInput!]!): EntityMutationPayload!
"""
Soft-delete entities with a reversible trash lifecycle.
"""
trashEntities(entities: [EntityRefInput!]!): EntityMutationPayload!
"""
Restore reversibly deleted entities.
"""
restoreEntities(entities: [EntityRefInput!]!): EntityMutationPayload!
"""
Irreversibly delete entities.
"""
deleteEntitiesPermanently(entities: [EntityRefInput!]!): EntityMutationPayload!
"""
Duplicate supported entities.
"""
duplicateEntities(inputs: [DuplicateEntityInput!]!): EntityMutationPayload!
"""
Add or remove an entity and return the generic entity mutation result.
"""
setEntityFavorite(entity: EntityRefInput!, favorite: Boolean!): GraphqlEntityMutationResult!
"""
Add or remove an entity and return the persisted favorite record.
"""
setFavorite(entity: EntityRefInput!, favorite: Boolean!): SetFavoritePayload!
"""
Persist the authenticated user's complete favorites order and return the authoritative list.
"""
reorderFavorites(input: ReorderFavoritesInput!): [GraphqlFavorite!]!
"""
Record a view or interaction in the authenticated user's channel activity.
"""
recordChannelActivity(input: RecordChannelActivityInput!): GraphqlChannelActivity!
"""
Update authenticated user-owned notifications and return authoritative rows.
"""
updateNotifications(input: UpdateNotificationsInput!): [GraphqlNotification!]!
"""
Update all notifications associated with the requested entities for the authenticated user.
"""
updateNotificationsForEntity(input: UpdateNotificationsForEntityInput!): [GraphqlNotification!]!
"""
Mark an accessible email thread as seen and return its authoritative cache record.
"""
markEmailThreadSeen(input: MarkEmailThreadSeenInput!): GraphqlSoupEmailThread!
"""
Mark an accessible email thread unread and return its authoritative cache record.
"""
markEmailThreadUnread(input: MarkEmailThreadUnreadInput!): GraphqlSoupEmailThread!
"""
Set provider-neutral mailbox state and return the authoritative thread.
"""
setEmailThreadState(input: SetEmailThreadStateInput!): GraphqlSoupEmailThread!
"""
Resolve an email write conflict and return the current canonical thread.
"""
resolveEmailMessageOperation(input: ResolveEmailMessageOperationInput!): GraphqlSoupEmailThread!
"""
Set archive-based Done and return the primary-backed canonical thread.
"""
setEmailThreadArchived(input: SetEmailThreadArchivedInput!): GraphqlSoupEmailThread!
"""
Set archive-based Done on many threads with one provider write per
inbox. Returns the threads that could not change and the
primary-backed record of every requested thread the caller can load.
"""
setEmailThreadsArchived(input: SetEmailThreadsArchivedInput!): SetEmailThreadsArchivedPayload!
"""
Add or remove one label from an accessible email thread and return its authoritative cache record.
"""
updateEmailThreadLabel(input: UpdateEmailThreadLabelInput!): GraphqlSoupEmailThread!
"""
Enqueue a message from a caller-accessible inbox using a verified sender.
Delivery uses the existing undo window and worker, not the offline mutation queue.
"""
sendEmailMessage(input: SendEmailMessageInput!): SendEmailMessagePayload!
"""
Create or update an email draft and return its thread's authoritative
cache record. The client-generated handle resolves through a
caller-scoped mapping to a server-minted row, so a save replayed from
the offline mutation queue converges instead of duplicating.
"""
saveEmailDraft(input: SaveEmailDraftInput!): SaveEmailDraftPayload!
"""
Delete an email draft. Idempotent: deleting an ID that is already
gone succeeds with `deleted: false`, so a delete replayed from the
offline mutation queue lands cleanly however late it arrives.
Deleting a draft that has since been sent fails with
`DRAFT_ALREADY_SENT`.
"""
deleteEmailDraft(input: DeleteEmailDraftInput!): DeleteEmailDraftPayload!
"""
Durably accept an immutable send snapshot; safe to replay after response loss.
"""
sendEmailAttempt(input: SendEmailAttemptInput!): SendEmailAttemptPayload!
"""
Revoke delivery authority even if the original send request has not arrived.
"""
cancelEmailSend(input: EmailSendAttemptInput!): SendEmailAttemptPayload!
"""
Create an initiative owned by the authenticated user.
"""
createInitiative(input: CreateInitiativeInput!): GraphqlSoupInitiative!
"""
Update project fields; owner-only sharing and membership policy remains in the domain.
"""
updateInitiative(initiativeId: ID!, input: UpdateInitiativeInput!): GraphqlSoupInitiative!
"""
Idempotently ensure the collaborative description surface of an initiative the viewer
can see, returning its id, which is the initiative's id. Call before connecting.
"""
ensureInitiativeDescriptionSurface(initiativeId: ID!): ID!
"""
Delete an initiative after its owner capability has been verified.
"""
deleteInitiative(initiativeId: ID!): Boolean!
"""
Create an event on one of the viewer's writable calendars.
"""
createCalendarEvent(input: CreateCalendarEventInput!): GraphqlCalendarMutationPayload!
"""
Patch an event, the whole series or one occurrence.
"""
updateCalendarEvent(input: UpdateCalendarEventInput!): GraphqlCalendarMutationPayload!
"""
Delete an event, one occurrence, or an occurrence onward.
"""
deleteCalendarEvent(input: DeleteCalendarEventInput!): GraphqlCalendarMutationPayload!
"""
Set the viewer's RSVP on an event, the whole series or one occurrence.
"""
respondToCalendarEvent(input: RespondToCalendarEventInput!): GraphqlCalendarMutationPayload!
"""
Add guests to an event, the whole series or one occurrence, without
touching anyone already invited. The organizer may, and so may a
guest the organizer lets invite others; Google emails the new guests.
"""
inviteCalendarEventGuests(input: InviteCalendarEventGuestsInput!): GraphqlCalendarMutationPayload!
"""
Mark work feed items done for the authenticated user: acknowledge the
notifications each entry showed and archive inbox email.
Notifications newer than an entry's `revision` stay active. Own work
is not acknowledged, so an item the user also worked on stays in the
work feed, seen. Tasks, discussions and pull requests themselves are
not completed.
"""
markWorkFeedItemsDone(input: MarkWorkFeedItemsDoneInput!): MarkWorkFeedItemsDonePayload!
"""
Reverse one mark-done for the authenticated user without overwriting
anything that happened since, and return the restored items' places
in the requested feed.
"""
undoWorkFeedItemsDone(input: UndoWorkFeedItemsDoneInput!): UndoWorkFeedItemsDonePayload!
"""
Mark notification inbox rows done for the authenticated user:
acknowledge the notifications each row shows and hides, and archive
an email row's thread. Notifications newer than a row's `revision`
stay active. Tasks, requests, reviews and pull requests themselves
are not completed.
"""
markNotificationInboxRowsDone(input: MarkNotificationInboxRowsDoneInput!): MarkNotificationInboxRowsDonePayload!
"""
Mark one notification of a row done for the authenticated user, with
the hidden notifications about the same message or comment. A row's last
shown notification completes the row, as marking the row done does.
Returns the row's group's place in the requested inbox.
"""
markNotificationInboxNotificationDone(input: MarkNotificationInboxNotificationDoneInput!): MarkNotificationInboxNotificationDonePayload!
"""
Clear the authenticated user's notification inbox one batch at a time:
every matching row the batch reads is marked done, its shown and hidden
notifications. Email threads are not archived. Repeat with
`nextCursor` until it is absent; each batch's undo token reverses that
batch.
"""
clearNotificationInbox(input: ClearNotificationInboxInput!): ClearNotificationInboxPayload!
"""
Reverse one mark-done for the authenticated user without overwriting
anything that happened since, and return the restored groups' places
in the requested inbox.
"""
undoNotificationInboxRowsDone(input: UndoNotificationInboxRowsDoneInput!): UndoNotificationInboxRowsDonePayload!
"""
Mark notification inbox rows seen for the authenticated user: the
notifications each row shows and hides become read. Returns the
updated groups' places in the requested inbox.
"""
markNotificationInboxRowsSeen(input: MarkNotificationInboxRowsSeenInput!): MarkNotificationInboxRowsSeenPayload!
"""
Create once; replaying the same owned ID returns its existing record.
"""
createSavedView(input: CreateSavedViewInput!): GraphqlSavedView!
"""
Replace supplied fields only if the caller owns the expected revision.
"""
updateSavedView(input: UpdateSavedViewInput!): GraphqlSavedView!
"""
Delete the expected owned revision; repeating a completed deletion returns the ID.
"""
deleteSavedView(input: DeleteSavedViewInput!): ID!
}
"""
Root subscription object combining realtime Soup, notification,
activity, work feed and notification inbox adapters.
"""
type CompleteSubscriptionRoot {
"""
Subscribe to realtime Soup updates for the authenticated user.
"""
soupUpdates: [SoupPatch!]!
"""
Frames appended to one accessible agent session's log from now on,
one run per flush, in log order. Each entry is the row `agentSession.log`
serves, so a subscriber folds the same bytes a reader of the log does.
The stream ends with an error when the subscriber falls behind: rows
were missed, and the log must be refetched.
"""
agentSessionLogAppended(sessionId: ID!): [GraphqlAgentSessionLogEntry!]!
"""
Subscribe to realtime notifications for the authenticated user.
"""
notificationUpdates: GraphqlNotificationPatch!
"""
Subscribe to realtime activity for the authenticated user.
"""
activityUpdates: GraphqlActivityPatch!
"""
Changes to the authenticated user's work feed in `scope`: entries to
insert or move, items to remove, and an invalidation when changes may
have been missed. Each payload is one batch to apply together. Start
it before fetching the first page and refetch after an invalidation;
the stream ends with an error when its sources end, after which the
client resubscribes and refetches.
"""
workFeedUpdates(scope: WorkFeedScopeInput): [WorkFeedPatch!]!
"""
Changes to the authenticated user's notification inbox in `scope`:
groups to insert or move with their current rows, groups to remove,
and an invalidation when changes may have been missed. Each payload
is one batch to apply together. Start it before fetching the first
page and refetch after an invalidation; the stream ends with an error
when its sources end, after which the client resubscribes and
refetches.
"""
notificationInboxUpdates(scope: NotificationInboxScopeInput): [NotificationInboxPatch!]!
"""
Changes to the registered work of `accountIds` that the authenticated
user can see: entries to show, entries to stop showing, and an
invalidation when changes may have been missed or sharing changed.
Each payload is one batch to apply together. Start it before fetching
`registeredWork` and refetch after an invalidation; the stream ends
with an error when its source ends, after which the client resubscribes
and refetches.
"""
registeredWorkUpdates(accountIds: [ID!]!): [GraphqlRegisteredWorkPatch!]!
}
"""
Create an event on one of the viewer's writable calendars.
"""
input CreateCalendarEventInput {
"""
Stable retry identity, scoped to the authenticated organizer.
"""
idempotencyKey: ID
"""
Exact calendar to create the event on; takes precedence over the
inbox default.
"""
calendarId: ID
"""
Connected inbox whose primary calendar receives the event; defaults
to the viewer's primary inbox.
"""
emailLinkId: ID
"""
Display title.
"""
title: String!
"""
Optional event body.
"""
description: String
"""
Optional location label.
"""
location: String
"""
Timed or all-day shape.
"""
time: CalendarEventTimeInput!
"""
Invited attendees.
"""
attendees: [CalendarAttendeeInput!]! = []
"""
Raw RFC 5545 recurrence properties (`RRULE`, `RDATE`, `EXDATE`).
"""
recurrenceLines: [String!]! = []
"""
Event visibility.
"""
visibility: GraphqlCalendarEventVisibility
"""
Availability behavior.
"""
transparency: GraphqlCalendarEventTransparency
"""
Reminder configuration; omit to keep the calendar defaults.
"""
reminders: CalendarRemindersInput
"""
Conference to attach; omit to create the event without one.
"""
conference: GraphqlCalendarConferenceChange
"""
Mint a Macro call and write its join link into the description and
location before creating the event, so the invitation carries it.
Cannot be combined with `conference`.
"""
macroCall: Boolean! = false
"""
Present to create an out-of-office status event (primary calendar
only, timed, no attendees).
"""
outOfOffice: CalendarOutOfOfficeInput
"""
What guests may do; omit for Google's defaults.
"""
guestPolicy: CalendarGuestPolicyInput
}
"""
Create an initiative owned by the authenticated viewer.
"""
input CreateInitiativeInput {
"""
Initial name.
"""
name: String!
"""
Initial description Markdown.
"""
description: String
"""
Initial collaborators.
"""
memberIds: [String!]
"""
Whether to share with the owner's team, defaulting to true.
"""
shareWithTeam: Boolean
"""
Initial property values, set in the same create; a rejected value fails it.
"""
propertyValues: [InitialPropertyValueInput!]
}
"""
Inputs for creating a saved view with a stable client-generated identity.
"""
input CreateSavedViewInput {
"""
Client-generated UUID reused when retrying the same creation.
"""
id: ID!
"""
Nonempty display name, limited to 120 characters.
"""
name: String!
"""
Consumer-owned JSON object, limited to 32 KiB.
"""
config: JSON!
"""
Current team to share with, or null for a private definition.
"""
sharedTeamId: ID
}
"""
Match the checked or unchecked state of a cell.
"""
input DatabaseViewCheckboxTest {
"""
Whether the cell must be checked.
"""
checked: Boolean!
}
"""
How the conditions within a filter group combine.
"""
enum DatabaseViewConjunction {
"""
Require every condition.
"""
AND
"""
Require at least one condition.
"""
OR
}
"""
An ordering comparison between instants.
"""
enum DatabaseViewDateOperator {
"""
The instant is before the comparison instant.
"""
BEFORE
"""
The instant is after the comparison instant.
"""
AFTER
"""
The instant is at or before the comparison instant.
"""
ON_OR_BEFORE
"""
The instant is at or after the comparison instant.
"""
ON_OR_AFTER
}
"""
How a date range relates to a day.
"""
enum DatabaseViewDateRangeOperator {
"""
The range overlaps the day.
"""
CONTAINS
"""
The range misses the day, or is empty.
"""
DOES_NOT_CONTAIN
"""
The range ends before the day.
"""
ENDS_BEFORE
"""
The range ends on or after the day.
"""
ENDS_ON_OR_AFTER
"""
The range starts after the day.
"""
STARTS_AFTER
"""
The range starts on or before the day.
"""
STARTS_ON_OR_BEFORE
}
"""
Compare a date range cell with the day starting at a UTC instant.
"""
input DatabaseViewDateRangeTest {
"""
The comparison to apply.
"""
operator: DatabaseViewDateRangeOperator!
"""
The start of the day compared against.
"""
value: DateTime!
}
"""
Compare a date cell with a UTC instant.
"""
input DatabaseViewDateTest {
"""
The comparison to apply.
"""
operator: DatabaseViewDateOperator!
"""
The value to compare the cell against.
"""
value: DateTime!
}
"""
Compare referenced entity identities with a set of entities.
"""
input DatabaseViewEntitiesTest {
"""
The comparison to apply.
"""
operator: DatabaseViewSetOperator!
"""
Referenced entity identities.
"""
entities: [String!]!
}
"""
A typed predicate on one column placement.
"""
input DatabaseViewFilterCondition {
"""
Column placement identity within the selected table.
"""
column: ID!
"""
The comparison appropriate for this column.
"""
test: DatabaseViewFilterTest!
}
"""
A conjunction of column conditions or nested groups.
"""
input DatabaseViewFilterGroup {
"""
Require every condition or at least one condition.
"""
conjunction: DatabaseViewConjunction!
"""
Column tests or nested groups.
"""
conditions: [DatabaseViewFilterNode!]!
}
"""
Exactly one column condition or nested filter group.
"""
input DatabaseViewFilterNode @oneOf {
"""
A predicate on one column.
"""
condition: DatabaseViewFilterCondition
"""
A nested group of predicates.
"""
group: DatabaseViewFilterGroup
}
"""
Exactly one test compatible with the selected column type.
"""
input DatabaseViewFilterTest @oneOf {
"""
Test cell emptiness.
"""
presence: DatabaseViewPresenceTest
"""
Test a text or link cell.
"""
text: DatabaseViewTextTest
"""
Test a numeric cell.
"""
number: DatabaseViewNumberTest
"""
Test a date cell.
"""
date: DatabaseViewDateTest
"""
Test a date range cell against a day.
"""
dateRange: DatabaseViewDateRangeTest
"""
Test a checkbox cell.
"""
checkbox: DatabaseViewCheckboxTest
"""
Test selected option identities.
"""
options: DatabaseViewOptionsTest
"""
Test referenced entity identities.
"""
entities: DatabaseViewEntitiesTest
}
"""
A numeric equality or ordering comparison.
"""
enum DatabaseViewNumberOperator {
"""
The value equals the comparison value.
"""
IS
"""
The value differs from the comparison value.
"""
IS_NOT
"""
The number is greater than the comparison value.
"""
GREATER_THAN
"""
The number is at least the comparison value.
"""
GREATER_THAN_OR_EQUAL
"""
The number is less than the comparison value.
"""
LESS_THAN
"""
The number is at most the comparison value.
"""
LESS_THAN_OR_EQUAL
}
"""
Compare a numeric cell with a finite number.
"""
input DatabaseViewNumberTest {
"""
The comparison to apply.
"""
operator: DatabaseViewNumberOperator!
"""
The value to compare the cell against.
"""
value: Float!
}
"""
Compare selected option identities with a set of options.
"""
input DatabaseViewOptionsTest {
"""
The comparison to apply.
"""
operator: DatabaseViewSetOperator!
"""
Option identities from the selected column.
"""
options: [ID!]!
}
"""
The requested cell-presence condition.
"""
enum DatabaseViewPresenceOperator {
"""
The cell has no value.
"""
IS_EMPTY
"""
The cell has a value.
"""
IS_NOT_EMPTY
}
"""
Test whether the cell has a value.
"""
input DatabaseViewPresenceTest {
"""
The comparison to apply.
"""
operator: DatabaseViewPresenceOperator!
}
"""
Filtering and ordering applied to the entire table before pagination.
"""
input DatabaseViewQueryInput {
"""
Optional filter; omission includes every row.
"""
filter: DatabaseViewFilterGroup
"""
Ordering keys in priority order; omission uses manual row order.
"""
sort: [DatabaseViewSort!]! = []
}
"""
A table view and its optional continuation, with a bounded page size.
"""
input DatabaseViewRowsInput {
"""
The table within the authorized database.
"""
tableId: ID!
"""
The complete filtering and ordering definition.
"""
query: DatabaseViewQueryInput!
"""
The preceding page’s opaque cursor; omit for the first page.
"""
cursor: String
"""
Page size from 1 through 500; defaults to 500.
"""
limit: Int
}
"""
Membership and order belong to this page; row facts retain their shared identity.
"""
type DatabaseViewRowsPage {
"""
Rows in global view order, hydrated as canonical Soup entities.
"""
items: [GraphqlSoupDatabaseRow!]!
"""
Continuation for the next page; absent at the end of the result.
"""
nextCursor: String
"""
Table version against which this page was selected.
"""
version: Int!
}
"""
A membership condition for single- or multi-valued cells.
"""
enum DatabaseViewSetOperator {
"""
The single-valued cell matches one supplied identity.
"""
IS_ANY_OF
"""
The single-valued cell matches no supplied identity.
"""
IS_NONE_OF
"""
The cell contains at least one supplied identity.
"""
HAS_ANY
"""
The cell contains every supplied identity.
"""
HAS_ALL
"""
The cell contains no supplied identity.
"""
HAS_NONE
}
"""
One ordering key; earlier keys take precedence.
"""
input DatabaseViewSort {
"""
Column placement identity within the selected table.
"""
column: ID!
"""
Ascending or descending value order.
"""
direction: DatabaseViewSortDirection!
}
"""
The direction of a view ordering key.
"""
enum DatabaseViewSortDirection {
"""
Order values from lowest to highest.
"""
ASCENDING
"""
Order values from highest to lowest.
"""
DESCENDING
}
"""
A text equality or substring comparison.
"""
enum DatabaseViewTextOperator {
"""
The value equals the comparison value.
"""
IS
"""
The value differs from the comparison value.
"""
IS_NOT
"""
The text contains the comparison string.
"""
CONTAINS
"""
The text does not contain the comparison string.
"""
DOES_NOT_CONTAIN
"""
The text starts with the comparison string.
"""
STARTS_WITH
"""
The text ends with the comparison string.
"""
ENDS_WITH
}
"""
Compare a text or link cell with a string.
"""
input DatabaseViewTextTest {
"""
The comparison to apply.
"""
operator: DatabaseViewTextOperator!
"""
The value to compare the cell against.
"""
value: String!
}
"""
Implement the DateTime<Utc> scalar
The input/output is a string in RFC3339 format.
"""
scalar DateTime
"""
Delete an event, one occurrence, or an occurrence onward.
"""
input DeleteCalendarEventInput {
"""
Event to delete.
"""
eventId: ID!
"""
Calendar whose copy of the event is deleted, for an event synced from
more than one calendar. Omit to delete the canonical copy.
"""
calendarId: ID
"""
Deletion scope; defaults to the entire event or series.
"""
scope: GraphqlCalendarDeletionScope! = ALL
"""
Original-start key of the occurrence a scoped deletion targets.
"""
recurrenceId: String
}
"""
Input for deleting an email draft.
"""
input DeleteEmailDraftInput {
"""
Generation from the last loaded draft.
"""
draftGeneration: Int
"""
Draft handle to delete: a client-generated ID or a server ID, resolved
like a save's. A handle that is already gone (or was never bound — a
discard can replay before its draft's first save ever committed)
deletes nothing and still succeeds, so a delete queued offline lands
cleanly however late it replays.
"""
draftId: ID!
}
"""
Result of deleting an email draft, including its surviving conversation.
"""
type DeleteEmailDraftPayload {
"""
Requested draft identity.
"""
draftId: ID!
"""
Whether a row was removed; an absent row is an idempotent success.
"""
deleted: Boolean!
"""
Whether the thread was also removed.
"""
threadDeleted: Boolean!
"""
Authorized thread identity, including a thread removed by this delete.
"""
threadId: ID
"""
Canonical surviving thread, when this delete found a draft.
"""
thread: GraphqlSoupEmailThread
}
"""
Inputs for a revision-guarded deletion.
"""
input DeleteSavedViewInput {
"""
Identity of the definition to delete.
"""
id: ID!
"""
Revision that must still match when the deletion commits.
"""
expectedRevision: Int!
}
"""
One entity duplication in a batch.
"""
input DuplicateEntityInput {
"""
Source entity to duplicate.
"""
entity: EntityRefInput!
"""
Optional display name for the new entity.
"""
displayName: String
}
"""
Opaque versions let the server reject a resolution of an obsolete conflict.
"""
type EmailMessageOperation {
"""
The current synchronization or delivery state of this message operation.
"""
state: EmailMessageOperationState!
"""
The opaque local revision that a resolution must acknowledge.
"""
revision: String!
"""
The observed provider version required to resolve an external draft conflict.
"""
remoteVersion: String
"""
The reason the operation needs attention, when one is available.
"""
issue: EmailMessageOperationIssue
}
"""
The decision needed from the user after a provider write could not complete.
"""
enum EmailMessageOperationIssue {
"""
The selected provider content is being loaded.
"""
ACCEPTING_REMOTE
"""
Local and provider edits conflict.
"""
DRAFT_CONFLICT
"""
Draft creation could not be confirmed.
"""
CREATION_UNKNOWN
"""
Attachment creation could not be confirmed.
"""
ATTACHMENT_UNKNOWN
"""
Delivery could not be confirmed; automatic resend is forbidden.
"""
SEND_UNKNOWN
"""
The provider definitively rejected delivery; a deliberate retry is safe.
"""
SEND_REJECTED
"""
The initiating user no longer has access.
"""
ACCESS_REVOKED
"""
The provider rejected the request.
"""
INVALID_CONTENT
"""
The old delivery identity is being retired.
"""
MOVE_PENDING
"""
The source draft changed before retirement.
"""
MOVE_CONFLICT
"""
The original was sent outside Macro.
"""
MOVE_SOURCE_SENT
"""
Source mailbox access must be restored.
"""
MOVE_REAUTHORIZATION
"""
Conditional cleanup is unavailable; the original remains in its mailbox.
"""
MOVE_ORIGINAL_REMAINS
}
"""
Provider-independent progress for an email write or delivery attempt.
"""
enum EmailMessageOperationState {
"""
Changes are waiting to synchronize.
"""
PENDING
"""
The current revision is synchronized.
"""
SYNCHRONIZED
"""
The provider changed since the local edit began.
"""
CONFLICT
"""
A write may have succeeded and needs reconciliation.
"""
UNCERTAIN
"""
The send attempt has been recorded.
"""
SUBMITTING
"""
Provider acceptance is being reconciled with sent mail.
"""
CONFIRMING
"""
The sent copy was confirmed.
"""
SENT
"""
The draft deletion was confirmed.
"""
DELETED
"""
The operation was cancelled.
"""
CANCELLED
"""
The operation needs a correction before retry.
"""
FAILED
}
"""
Domain-facing capability required by email thread mutations.
"""
enum EmailMessageResolutionAction {
"""
Apply local edits over the reviewed provider version.
"""
KEEP_LOCAL
"""
Replace the local editor content with the provider's current draft.
"""
USE_PROVIDER
"""
Reconcile the recorded uncertain operation again.
"""
RECHECK
"""
Deliberately retry delivery after acknowledging possible duplication.
"""
RETRY_SEND
}
"""
Identifies one send action independently of its server message identity.
"""
input EmailSendAttemptInput {
"""
Stable UUID generated for the explicit Send action.
"""
attemptId: ID!
"""
Sending inbox captured at Send, never inferred during replay.
"""
linkId: ID!
}
"""
Current result of one replay-safe send action.
"""
type EmailSendAttemptPayload {
"""
Stable send-action identity.
"""
attemptId: ID!
"""
Current delivery state.
"""
status: EmailSendStatus!
"""
First acceptance's delivery deadline, preserved across retries.
"""
sendTime: String
"""
Current message, absent if cancelled before admission or subsequently deleted.
"""
message: GraphqlSoupEmailMessage
"""
Server conversation identity, when admitted.
"""
threadId: ID
}
"""
Authoritative delivery state; acceptance is not proof of provider delivery.
"""
enum EmailSendStatus {
"""
Durably accepted; preparation may be retried and cancellation remains safe.
"""
ACCEPTED
"""
Submission began, or a legacy claim has an unknown outcome; cancellation is unsafe.
"""
SENDING
"""
Delivery failed before acceptance; cancellation can restore the draft.
"""
FAILED
"""
Delivery may have occurred and is being reconciled without resending.
"""
DELIVERY_UNCONFIRMED
"""
Provider delivery was recorded.
"""
SENT
"""
This attempt cannot deliver.
"""
CANCELLED
}
"""
Input for fetching one email thread by its canonical identifier.
"""
input EmailThreadInput {
"""
The canonical email thread identifier.
"""
threadId: ID!
}
"""
Semantic state fields shared by every mailbox provider.
"""
enum EmailThreadStateField {
"""
Read/unread state.
"""
READ
"""
Follow-up star/flag.
"""
STARRED
"""
Recoverable trash membership.
"""
TRASHED
"""
Junk membership.
"""
JUNK
}
"""
Results for a batch mutation, preserving the input order.
"""
type EntityMutationPayload {
"""
Per-input mutation outcomes.
"""
results: [GraphqlEntityMutationResult!]!
}
"""
One property's option delta within an options update.
"""
input EntityPropertyOptionDeltaInput {
"""
Identifier of the multi-select property definition being changed.
"""
propertyDefinitionId: ID!
"""
Options to add to the currently stored value.
"""
addOptionIds: [ID!]!
"""
Options to strip from the currently stored value.
"""
removeOptionIds: [ID!]!
}
"""
Canonical entity reference accepted by unified mutations.
"""
input EntityRefInput {
"""
Entity kind.
"""
type: GraphqlEntityType!
"""
Entity identifier in that kind's canonical namespace.
"""
id: ID!
}
"""
Shared link, explicit team, and channel share-policy update.
"""
input EntitySharePolicyInput {
"""
Link-sharing audience. Omit to leave unchanged or pass null to disable link sharing.
"""
linkShare: GraphqlLinkShare
"""
Link access level. Omit to leave unchanged or pass null to reset it to the default level
when a link share exists.
"""
linkShareAccessLevel: GraphqlEntityAccessLevel
"""
Explicit team access level. Omit to leave unchanged or pass null to disable team sharing,
independently of link sharing. Only the actual owner may change this setting;
enabling it requires the owner to belong to a team. OWNER is not an allowed level.
"""
teamShareAccessLevel: GraphqlEntityAccessLevel
"""
Channel access entries to add, remove, or replace.
"""
channelSharePermissions: [ChannelSharePolicyInput!]
}
"""
Which of the authenticated user's favorites to return.
The two dimensions are independent. Values of one are alternatives, and
both must hold. An omitted or empty list constrains nothing, so the whole
collection is the default.
"""
input FavoritesFilterInput {
"""
Restrict to favorites of these entity types.
"""
entityTypes: [GraphqlEntityType!]! = []
"""
Restrict to favorites with these entity ids.
"""
entityIds: [ID!]! = []
}
"""
Item-style permission represented by the viewer's effective access level.
"""
type GraphqlAccessLevelPermission {
"""
Effective access level held by the viewer.
"""
accessLevel: GraphqlEntityAccessLevel!
}
"""
The typed activity-action vocabulary. One member per durable action, plus
[`GraphqlActivityUnknownAction`]: rows written by a newer deployment (or
with an undecodable payload) surface with their raw tag and payload
instead of failing the page.
"""
union GraphqlActivityAction = GraphqlActivityCreated | GraphqlActivityEdited | GraphqlActivityOpened | GraphqlActivityDeleted | GraphqlActivityMessaged | GraphqlActivitySent | GraphqlActivityResponded | GraphqlActivityPropertyChanged | GraphqlActivityParticipantAdded | GraphqlActivityParticipantRemoved | GraphqlActivityCallStarted | GraphqlActivityTaskAdded | GraphqlActivityTaskRemoved | GraphqlActivityUnknownAction
"""
A call was started in the entity.
"""
type GraphqlActivityCallStarted {
"""
The started call.
"""
callId: ID!
}
"""
The entity was created.
"""
type GraphqlActivityCreated {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
One local date with activity.
"""
type GraphqlActivityDay {
"""
Local date in `YYYY-MM-DD` form.
"""
date: String!
"""
Number of activities on that date.
"""
count: Int!
}
"""
The entity was soft-deleted.
"""
type GraphqlActivityDeleted {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
The entity's content or metadata was edited.
"""
type GraphqlActivityEdited {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
One entity ranked by its activity count.
"""
type GraphqlActivityEntityRank {
"""
Kind of entity.
"""
entityType: GraphqlEntityType!
"""
Entity identifier.
"""
entityId: ID!
"""
Number of activities that touched the entity.
"""
count: Int!
}
"""
One activity: a principal did something to an entity at a time.
Carries an entity *reference* only (`entityType`/`entityId`) — clients
resolve names and metadata from their normalized Soup cache.
"""
type GraphqlActivityEvent {
"""
The activity's stable identifier.
"""
id: ID!
"""
The principal that mechanically acted, as a prefix-parseable string
(`macro|<email>` for users, `bot|<uuid>` for bots).
"""
actorId: String!
"""
Whose activity this is: the delegating user when the actor acted on
someone's behalf, otherwise the actor itself.
"""
subjectId: String!
"""
The kind of entity acted on.
"""
entityType: GraphqlEntityType!
"""
The entity acted on.
"""
entityId: ID!
"""
What the principal did.
"""
action: GraphqlActivityAction!
"""
When it happened, in RFC 3339 format.
"""
occurredAt: String!
}
"""
A content-free signal to refresh activity through authorized queries.
"""
type GraphqlActivityInvalidation {
"""
True when mounted activity queries need a fresh read.
"""
refresh: Boolean!
}
"""
A message was sent in the entity.
"""
type GraphqlActivityMessaged {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
The entity was opened by its subject.
"""
type GraphqlActivityOpened {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
Activity aggregated over the authenticated user's trailing year.
This value has no `id`, so the normalized client cache embeds it under
the authenticated user instead of treating it as a global entity.
"""
type GraphqlActivityOverview {
"""
First local date, inclusive, in `YYYY-MM-DD` form.
"""
from: String!
"""
One past the final local date, exclusive, in `YYYY-MM-DD` form.
"""
to: String!
"""
IANA time zone used for the window and day buckets.
"""
timeZone: String!
"""
Total activity in the window.
"""
total: Int!
"""
Sparse positive day counts in ascending order.
"""
days: [GraphqlActivityDay!]!
"""
Most active entities in stable rank order.
"""
topEntities: [GraphqlActivityEntityRank!]!
}
"""
One page of activity, newest first.
"""
type GraphqlActivityPage {
"""
The page's activity events.
"""
items: [GraphqlActivityEvent!]!
"""
Cursor for the next page; absent when this page reached the end.
"""
nextCursor: String
}
"""
A principal was added to the entity.
"""
type GraphqlActivityParticipantAdded {
"""
The added principal, as a prefix-parseable string.
"""
participant: String!
}
"""
A principal was removed from the entity.
"""
type GraphqlActivityParticipantRemoved {
"""
The removed principal, as a prefix-parseable string.
"""
participant: String!
}
"""
Realtime activity patch: a recorded event or a purge invalidation.
"""
union GraphqlActivityPatch = GraphqlActivityEvent | GraphqlActivityInvalidation
"""
A property value changed on the entity.
"""
type GraphqlActivityPropertyChanged {
"""
The property definition id.
"""
property: String!
"""
The previous value, when the source event carried it.
"""
from: JSON
"""
The new value. `null` means the value was cleared — or was literally
set to JSON null; the wire cannot distinguish the two.
"""
to: JSON
}
"""
Someone submitted a response to the entity.
"""
type GraphqlActivityResponded {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
An email message was sent on the thread.
"""
type GraphqlActivitySent {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
A task was added to a project.
"""
type GraphqlActivityTaskAdded {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
A task was removed from a project.
"""
type GraphqlActivityTaskRemoved {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
An action this deployment's vocabulary doesn't know.
"""
type GraphqlActivityUnknownAction {
"""
The stored action tag.
"""
tag: String!
"""
The stored action payload, verbatim.
"""
payload: JSON
}
"""
Last synchronized state of a session's linked GitHub pull request.
"""
enum GraphqlAgentPullRequestState {
"""
The pull request accepts changes.
"""
OPEN
"""
The pull request is still a draft.
"""
DRAFT
"""
The pull request was closed without merging.
"""
CLOSED
"""
The pull request was merged.
"""
MERGED
}
"""
Who or what archived an agent session.
"""
enum GraphqlAgentSessionArchiveCause {
"""
A person archived it.
"""
USER
"""
Every pull request linked to it closed, with at least one merged.
"""
PULL_REQUEST_MERGED
"""
The runtime session backing it was deliberately closed.
"""
RUNTIME_CLOSED
}
"""
The two operands of a recursive `AgentSessionFilterExpr` binary expression.
"""
input GraphqlAgentSessionBinaryExpr {
"""
Left expression.
"""
left: GraphqlAgentSessionExpr!
"""
Right expression.
"""
right: GraphqlAgentSessionExpr!
}
"""
A recursive `AgentSessionFilterExpr` filter expression.
"""
input GraphqlAgentSessionExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlAgentSessionBinaryExpr
"""
Either expression may match.
"""
or: GraphqlAgentSessionBinaryExpr
"""
Negate an expression.
"""
not: GraphqlAgentSessionExpr
"""
Match a literal.
"""
literal: GraphqlAgentSessionLiteral
}
"""
GraphQL input representing the agent session literal.
"""
input GraphqlAgentSessionLiteral @oneOf {
"""
Opt this query into agent sessions at all. Agent sessions are off by
default, so without this (or an `id`/`owner`) Soup omits them entirely.
Must be `true`; there is no literal for excluding agent sessions, that
is the default.
"""
include: Boolean
"""
The id option.
"""
id: ID
"""
The owner principal option — a user (`macro|<email>`), a bot
(`bot|<uuid>`), or a team (a bare hyphenated uuid).
"""
owner: String
"""
Who started the session. Narrows the sessions a query asks for; it
does not opt the query in.
"""
source: GraphqlAgentSessionSource
"""
Whether the session is listed. Narrows the sessions a query asks for;
it does not opt the query in.
"""
visibility: GraphqlAgentSessionVisibility
}
"""
One session's raw protocol log and the agent whose messages it derives.
"""
type GraphqlAgentSessionLog {
"""
The bot the session runs as: the sender of every agent message.
"""
bot: GraphqlAgentSessionLogBot!
"""
Effective history in ascending `(createdAt, id)` order. The first row
is the inclusive history boundary; a reader reconciles overlap by id.
"""
entries: [GraphqlAgentSessionLogEntry!]!
}
"""
The bot as the log's reader needs it, handle included.
"""
type GraphqlAgentSessionLogBot {
"""
The bot's id. A message it sent has `"bot|{id}"` as its sender.
"""
id: ID!
"""
Display name.
"""
name: String!
"""
Stable `@` handle, without a leading `@`.
"""
handle: String!
"""
Avatar, when it has one.
"""
avatarUrl: String
}
"""
One logged frame, in the shape the fold reads: the transport row's
identity and time beside the frame's own `direction` and `content`.
"""
type GraphqlAgentSessionLogEntry {
"""
Durable transport row identity; with `createdAt`, its order cursor.
"""
id: ID!
"""
When the log recorded the frame.
"""
createdAt: String!
"""
The user whose action produced the frame, absent when no user did.
"""
userId: String
"""
Which way the frame travelled: `to_server` or `to_runtime`.
"""
direction: String!
"""
The protocol envelope, verbatim.
"""
content: JSON!
}
"""
Metadata for being named in a prompt to an agent session.
"""
type GraphqlAgentSessionMentionedMetadata {
"""
The session this is about.
"""
session: GraphqlAgentSessionRef!
"""
Who wrote the prompt.
"""
mentionedBy: String
"""
The action carrying the prompt.
"""
actionId: ID!
}
"""
The session an agent-session notification points at.
"""
type GraphqlAgentSessionRef {
"""
Agent session identifier; what a click opens.
"""
sessionId: ID!
"""
Session name at the time of the event.
"""
sessionName: String!
"""
Bot identifier.
"""
botId: ID!
"""
Bot display name; agent notifications read as being from the bot.
"""
botName: String!
"""
Channel the session was opened from, when it was.
"""
channelId: ID
"""
Thread the session was opened from, when it was.
"""
threadId: ID
"""
The magic-chip message for the turn, when one was posted.
"""
announcementMessageId: ID
}
"""
Metadata for an agent session that finished with nothing queued.
"""
type GraphqlAgentSessionSettledMetadata {
"""
The session this is about.
"""
session: GraphqlAgentSessionRef!
"""
The turn that ended.
"""
turn: Int!
"""
Who prompted the turn.
"""
actor: String
"""
ACP stop reason, or `error`.
"""
stopReason: String!
"""
The agent's last prose in the turn.
"""
excerpt: String
}
"""
Who started an agent session: filter input, and the field Soup returns.
"""
enum GraphqlAgentSessionSource {
"""
A person, directly or through something they did.
"""
USER
"""
Another agent, which dispatched the session on its owner's behalf.
"""
AGENT
"""
A routine's unattended run.
"""
ROUTINE
}
"""
Where an agent session is shown: filter input, and the field Soup returns.
"""
enum GraphqlAgentSessionVisibility {
"""
Shown wherever the owner's sessions are.
"""
LISTED
"""
Left out of Home and the default Agents list, but a filter can still
ask for it; a routine's setting decides it for each of its runs.
"""
UNLISTED
"""
Out of every list and search; only a query naming the session's id
returns it.
"""
HIDDEN
}
"""
Metadata for an agent session blocked on a question.
"""
type GraphqlAgentSessionWaitingForInputMetadata {
"""
The session this is about.
"""
session: GraphqlAgentSessionRef!
"""
The turn asking.
"""
turn: Int!
"""
The question, as the agent phrased it.
"""
question: String!
}
"""
Metadata for an AI response.
"""
type GraphqlAiResponseMetadata {
"""
AI response summary.
"""
summary: String!
"""
Response message identifier.
"""
messageId: String!
}
"""
An all-day span using RFC 5545's exclusive end date.
"""
type GraphqlAllDayEventTime {
"""
Inclusive local start date (`YYYY-MM-DD`).
"""
startDate: String!
"""
Exclusive local end date (`YYYY-MM-DD`).
"""
endDate: String!
}
"""
A Boolean property value.
"""
type GraphqlBooleanPropertyValue {
"""
The stored Boolean.
"""
value: Boolean!
}
"""
Marker instructing a normalized GraphQL cache to delete one entity record.
"""
type GraphqlCacheDeletion {
"""
Concrete GraphQL object type used in the normalized cache key.
"""
graphqlTypeName: String!
"""
Identifier used in the normalized cache key.
"""
entityId: ID!
}
"""
A calendar visible to the viewer.
"""
type GraphqlCalendar {
"""
Macro calendar identifier.
"""
id: ID!
"""
Connected inbox that syncs this calendar.
"""
linkId: ID!
"""
Connected inbox address.
"""
emailAddress: String!
"""
Calendar provider, for display and reconnect routing.
"""
provider: GraphqlCalendarProvider!
"""
Provider features available on this actual calendar.
"""
capabilities: GraphqlCalendarCapabilities!
"""
Provider display name.
"""
name: String!
"""
Provider color.
"""
color: String
"""
Whether this is its account's primary calendar.
"""
isPrimary: Boolean!
"""
Whether the grant can create and modify events on this calendar.
"""
isWritable: Boolean!
"""
Whether this is a shared system calendar (holidays, birthdays).
"""
isSubscription: Boolean!
"""
A persistent sync failure isolated to this calendar.
"""
syncError: String
"""
Default reminders applied to events that keep `useDefault`.
"""
defaultReminders: [GraphqlCalendarReminderOverride!]!
}
"""
One event attendee.
"""
type GraphqlCalendarAttendee {
"""
Attendee email address.
"""
email: String!
"""
Attendee display name.
"""
displayName: String
"""
The attendee's RSVP.
"""
responseStatus: GraphqlCalendarAttendeeResponseStatus!
"""
Whether the attendee organizes the event.
"""
isOrganizer: Boolean!
"""
Whether the attendee is optional.
"""
isOptional: Boolean!
"""
Whether the attendee is one of the viewer's own connected inboxes.
"""
isSelf: Boolean!
"""
The attendee's RSVP comment.
"""
comment: String
}
"""
An attendee's RSVP.
"""
enum GraphqlCalendarAttendeeResponseStatus {
"""
The attendee has not responded.
"""
NEEDS_ACTION
"""
The attendee accepted.
"""
ACCEPTED
"""
The attendee declined.
"""
DECLINED
"""
The attendee tentatively accepted.
"""
TENTATIVE
}
"""
Actual provider capabilities used by calendar editors.
"""
type GraphqlCalendarCapabilities {
"""
Whether event-level automatic invitation declines are supported.
"""
autoDecline: Boolean!
"""
Conferencing system available when creating an online meeting.
"""
conferenceProvider: GraphqlCalendarConferenceProvider
"""
Whether arbitrary RFC 5545 recurrence properties can be written.
"""
customRecurrence: Boolean!
"""
Whether email reminders are delivered by the provider or Macro.
"""
emailReminders: Boolean!
"""
Whether an existing conference can be detached.
"""
removeConference: Boolean!
"""
Whether an attendee can reset their RSVP to unanswered.
"""
resetRsvp: Boolean!
"""
Whether the organizer can set what guests may do.
"""
guestPolicy: Boolean!
}
"""
One bounded page of calendar changes after a watermark.
"""
type GraphqlCalendarChanges {
"""
Events created or changed, each with its full occurrence set.
"""
events: [GraphqlCalendarEventChange!]!
"""
Events that no longer exist or no longer have a visible occurrence.
"""
deletedEventIds: [ID!]!
"""
Calendars created or changed.
"""
calendars: [GraphqlCalendar!]!
"""
Calendars that were removed.
"""
deletedCalendarIds: [ID!]!
"""
Position after this page, one entry per currently visible connected
inbox. An inbox missing here is no longer visible.
"""
newWatermark: [GraphqlCalendarLinkWatermark!]!
"""
Whether more changes follow `newWatermark`.
"""
hasMore: Boolean!
"""
Whether the client must drop every calendar record and coverage it
holds and refetch: its watermark fell behind retention, or an inbox
became visible that it never tracked.
"""
resetRequired: Boolean!
}
"""
A change to an event's conference.
"""
enum GraphqlCalendarConferenceChange {
"""
Generate a new Microsoft Teams conference and attach it.
"""
MICROSOFT_TEAMS
"""
Generate a new Google Meet conference and attach it.
"""
GOOGLE_MEET
"""
Detach whatever conference is currently attached.
"""
NONE
}
"""
Conferencing system backing an event's join URL.
"""
enum GraphqlCalendarConferenceProvider {
"""
Microsoft Teams.
"""
MICROSOFT_TEAMS
"""
Google Meet.
"""
GOOGLE_MEET
"""
Any other conferencing system.
"""
OTHER
}
"""
How much of a recurring series a deletion removes.
"""
enum GraphqlCalendarDeletionScope {
"""
The entire event or series.
"""
ALL
"""
One occurrence.
"""
THIS_EVENT
"""
One occurrence and everything after it.
"""
THIS_AND_FOLLOWING
}
"""
A calendar event entity: the series content shared by every occurrence.
"""
type GraphqlCalendarEvent {
"""
Macro event identifier.
"""
id: ID!
"""
Macro user who owns this event projection.
"""
ownerId: String!
"""
Connected inbox whose grant backs the event.
"""
linkId: ID!
"""
RFC 5545 UID used to reconcile provider and email sources.
"""
icalUid: String!
"""
Calendar the canonical source belongs to, when known.
"""
calendarId: ID
"""
Content of every active copy of this event, canonical first.
"""
sources: [GraphqlCalendarEventSource!]!
"""
Display title.
"""
title: String!
"""
Optional event body.
"""
description: String
"""
Optional physical or virtual location label.
"""
location: String
"""
Event status.
"""
status: GraphqlCalendarEventStatus!
"""
Event visibility.
"""
visibility: GraphqlCalendarEventVisibility!
"""
Availability behavior.
"""
transparency: GraphqlCalendarEventTransparency!
"""
Provider event type.
"""
eventType: GraphqlCalendarEventType!
"""
The series time span.
"""
time: GraphqlEventTime!
"""
Raw RFC 5545 recurrence properties (`RRULE`, `RDATE`, `EXDATE`).
"""
recurrenceLines: [String!]!
"""
Organizer email.
"""
organizerEmail: String
"""
Organizer display name.
"""
organizerName: String
"""
Provider-reported creator email.
"""
creatorEmail: String
"""
Provider-reported creator display name.
"""
creatorName: String
"""
Direct join URL when known.
"""
conferenceUrl: String
"""
Which conferencing system backs `conferenceUrl`.
"""
conferenceProvider: GraphqlCalendarConferenceProvider
"""
Provider/iCalendar sequence number.
"""
sequence: Int!
"""
Whether the canonical source's calendar prohibits editing it.
"""
isReadOnly: Boolean!
"""
Series attendees.
"""
attendees: [GraphqlCalendarAttendee!]!
"""
Reminder configuration.
"""
reminders: GraphqlCalendarReminders!
"""
What the organizer lets guests do.
"""
guestPolicy: GraphqlCalendarGuestPolicy!
"""
Whether this is a snapshot of a meeting shared with the owner: a
private copy the meeting's changes never reach.
"""
isSnapshot: Boolean!
"""
What the viewer may do with the event.
"""
viewerCan: GraphqlCalendarViewerCapabilities!
"""
Entity creation time in RFC 3339 format.
"""
createdAt: String!
"""
Entity update time in RFC 3339 format.
"""
updatedAt: String!
}
"""
The two operands of a recursive `CalendarEventFilterExpr` binary expression.
"""
input GraphqlCalendarEventBinaryExpr {
"""
Left expression.
"""
left: GraphqlCalendarEventExpr!
"""
Right expression.
"""
right: GraphqlCalendarEventExpr!
}
"""
A changed event with its complete current set of visible occurrences.
Clients replace everything they hold for the event with it.
"""
type GraphqlCalendarEventChange {
"""
The series event.
"""
event: GraphqlCalendarEvent!
"""
Every non-cancelled materialized occurrence, ordered by start.
"""
occurrences: [GraphqlCalendarOccurrence!]!
}
"""
A recursive `CalendarEventFilterExpr` filter expression.
"""
input GraphqlCalendarEventExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlCalendarEventBinaryExpr
"""
Either expression may match.
"""
or: GraphqlCalendarEventBinaryExpr
"""
Negate an expression.
"""
not: GraphqlCalendarEventExpr
"""
Match a literal.
"""
literal: GraphqlCalendarEventLiteral
}
"""
Metadata for a request to be added as a guest of a shared calendar event.
"""
type GraphqlCalendarEventJoinRequestMetadata {
"""
Join request identifier.
"""
requestId: ID!
"""
The shared calendar event identifier.
"""
eventId: ID!
"""
Event display title when the request was made.
"""
title: String!
}
"""
GraphQL input representing a calendar event literal.
"""
input GraphqlCalendarEventLiteral @oneOf {
"""
Canonical event id.
"""
id: ID
"""
Event status.
"""
status: String
"""
Master start must be before this RFC3339 instant.
"""
startsBefore: String
"""
Master end must be after this RFC3339 instant.
"""
endsAfter: String
"""
Attendee email.
"""
attendee: String
"""
Organizer email.
"""
organizer: String
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
}
"""
Metadata for a due calendar event reminder.
"""
type GraphqlCalendarEventReminderMetadata {
"""
Calendar event identifier.
"""
eventId: ID!
"""
Stable occurrence key of the event instance.
"""
occurrenceKey: String!
"""
Event display title.
"""
title: String!
"""
Timed event start in RFC 3339 format.
"""
startsAt: String
"""
Timed event end in RFC 3339 format.
"""
endsAt: String
"""
All-day event start date in ISO 8601 format.
"""
startDate: String
"""
IANA time zone used to render the event.
"""
timeZone: String
"""
Minutes before the event start when the alarm fires.
"""
minutesBefore: Int!
}
"""
Content of one calendar's copy of an event.
"""
type GraphqlCalendarEventSource {
"""
Calendar this copy lives on.
"""
calendarId: ID!
"""
Display title.
"""
title: String!
"""
Optional event body.
"""
description: String
"""
Optional physical or virtual location label.
"""
location: String
"""
Provider event type.
"""
eventType: GraphqlCalendarEventType!
"""
Event visibility.
"""
visibility: GraphqlCalendarEventVisibility!
"""
Availability behavior.
"""
transparency: GraphqlCalendarEventTransparency!
"""
Whether the calendar's access role prohibits editing this copy.
"""
isReadOnly: Boolean!
"""
Reminder configuration of this copy.
"""
reminders: GraphqlCalendarReminders!
"""
Provider-reported creator email.
"""
creatorEmail: String
"""
Provider-reported creator display name.
"""
creatorName: String
}
"""
Event status.
"""
enum GraphqlCalendarEventStatus {
"""
The event is confirmed.
"""
CONFIRMED
"""
The event is tentatively confirmed.
"""
TENTATIVE
"""
The event was cancelled.
"""
CANCELLED
}
"""
Whether the event blocks time on the calendar.
"""
enum GraphqlCalendarEventTransparency {
"""
The event blocks time.
"""
OPAQUE
"""
The event does not block time.
"""
TRANSPARENT
}
"""
Provider event type.
"""
enum GraphqlCalendarEventType {
"""
A regular event.
"""
DEFAULT
"""
An out-of-office block.
"""
OUT_OF_OFFICE
"""
A focus-time block.
"""
FOCUS_TIME
"""
A working-location marker.
"""
WORKING_LOCATION
"""
A contact's birthday.
"""
BIRTHDAY
"""
An event Gmail created from an email.
"""
FROM_GMAIL
}
"""
Event visibility.
"""
enum GraphqlCalendarEventVisibility {
"""
The calendar's default visibility.
"""
DEFAULT
"""
Visible to everyone with access to the calendar.
"""
PUBLIC
"""
Details visible only to attendees.
"""
PRIVATE
"""
Treated as private.
"""
CONFIDENTIAL
}
"""
What the organizer lets an event's guests do.
"""
type GraphqlCalendarGuestPolicy {
"""
Whether guests may change the event, including its guest list.
"""
canModify: Boolean!
"""
Whether guests may invite others.
"""
canInviteOthers: Boolean!
"""
Whether guests may see the guest list.
"""
canSeeOtherGuests: Boolean!
}
"""
How far the viewer's client has read one connected inbox's calendar
change log.
"""
type GraphqlCalendarLinkWatermark {
"""
Connected inbox identifier.
"""
linkId: ID!
"""
Last change-log sequence covered, as a decimal string.
"""
seq: String!
}
"""
An event's committed state after a calendar mutation.
"""
type GraphqlCalendarMutationPayload {
"""
The series event after the write; null when it no longer exists or
has no visible occurrence left.
"""
event: GraphqlCalendarEvent
"""
Every visible occurrence of the event after the write, then each
occurrence the write removed, returned with `isCancelled: true` so a
normalized cache hides it as the response lands. Clients replace
everything they hold for the event with the uncancelled ones.
"""
occurrences: [GraphqlCalendarOccurrence!]!
"""
Set to the event's id when the write removed it.
"""
deletedEventId: ID
}
"""
One materialized instance of a calendar event.
`eventId` and `linkId` repeat the event's identity as scalars so a client
range index can project occurrences without dereferencing the event.
"""
type GraphqlCalendarOccurrence {
"""
`{eventId}:{occurrenceKey}`.
"""
id: ID!
"""
Owning event identifier.
"""
eventId: ID!
"""
Connected inbox whose grant backs the event.
"""
linkId: ID!
"""
The series event.
"""
event: GraphqlCalendarEvent!
"""
Stable key within the event.
"""
occurrenceKey: String!
"""
Provider recurrence identifier, when applicable.
"""
recurrenceId: String
"""
Instance time.
"""
time: GraphqlEventTime!
"""
Whether the instance was cancelled.
"""
isCancelled: Boolean!
"""
Title replacing the series title on this instance alone.
"""
overrideTitle: String
"""
Description replacing the series description on this instance alone.
"""
overrideDescription: String
"""
Location replacing the series location on this instance alone.
"""
overrideLocation: String
"""
Status replacing the series status on this instance alone.
"""
overrideStatus: GraphqlCalendarEventStatus
"""
Attendee list replacing the series list on this instance alone, where
an instance-scoped RSVP is recorded.
"""
overrideAttendees: [GraphqlCalendarAttendee!]
}
"""
One page of occurrences overlapping a viewport.
"""
type GraphqlCalendarOccurrencePage {
"""
Occurrences ordered by start, event, and occurrence key.
"""
nodes: [GraphqlCalendarOccurrence!]!
"""
Whether another page follows.
"""
hasNextPage: Boolean!
"""
Cursor for the next page, present when `hasNextPage` is true.
"""
endCursor: String
"""
Aggregate ingestion state; clients render a skeleton while syncing.
"""
syncStatus: GraphqlCalendarSyncStatus!
"""
Change-log position of every visible connected inbox, captured before
the page was read.
"""
watermark: [GraphqlCalendarLinkWatermark!]!
}
"""
How an out-of-office event answers conflicting invitations.
"""
enum GraphqlCalendarOutOfOfficeAutoDeclineMode {
"""
Leave conflicting invitations alone.
"""
DECLINE_NONE
"""
Decline every conflicting invitation, existing and new.
"""
DECLINE_ALL_CONFLICTING_INVITATIONS
"""
Decline only invitations that arrive after the event is created.
"""
DECLINE_ONLY_NEW_CONFLICTING_INVITATIONS
}
"""
Provider selected from the persisted calendar account and email binding.
"""
enum GraphqlCalendarProvider {
"""
Google Calendar.
"""
GOOGLE
"""
Microsoft Outlook calendar.
"""
OUTLOOK
}
"""
One reminder override.
"""
type GraphqlCalendarReminderOverride {
"""
Delivery method (`popup` or `email`).
"""
method: String!
"""
Minutes before the start the reminder fires.
"""
minutes: Int!
}
"""
An event's reminder configuration.
"""
type GraphqlCalendarReminders {
"""
Whether the calendar's default reminders apply.
"""
useDefault: Boolean!
"""
Explicit reminders, used when `useDefault` is false.
"""
overrides: [GraphqlCalendarReminderOverride!]!
}
"""
How much of a recurring series an RSVP applies to.
"""
enum GraphqlCalendarRsvpScope {
"""
The entire series.
"""
ALL
"""
One occurrence.
"""
THIS_EVENT
}
"""
Aggregate ingestion state across every calendar account visible to the
viewer.
"""
enum GraphqlCalendarSyncStatus {
"""
At least one visible calendar account is still ingesting.
"""
SYNCING
"""
Every visible calendar account has finished its latest sync.
"""
READY
}
"""
How much of a recurring series an update applies to.
"""
enum GraphqlCalendarUpdateScope {
"""
The entire event or series.
"""
ALL
"""
One occurrence.
"""
THIS_EVENT
}
"""
What the viewer may do with an event.
"""
type GraphqlCalendarViewerCapabilities {
"""
Change the event's details (title, time, description, conference).
"""
editDetails: Boolean!
"""
Add guests.
"""
inviteGuests: Boolean!
"""
Remove guests.
"""
removeGuests: Boolean!
"""
Change the event's guest policy, which only Google calendars have.
"""
setGuestPolicy: Boolean!
"""
Answer the invitation.
"""
rsvp: Boolean!
"""
Act as the event's organizer: replace its whole guest list and manage
its conferencing.
"""
organize: Boolean!
}
"""
The two operands of a recursive `CallFilterExpr` binary expression.
"""
input GraphqlCallBinaryExpr {
"""
Left expression.
"""
left: GraphqlCallExpr!
"""
Right expression.
"""
right: GraphqlCallExpr!
}
"""
A recursive `CallFilterExpr` filter expression.
"""
input GraphqlCallExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlCallBinaryExpr
"""
Either expression may match.
"""
or: GraphqlCallBinaryExpr
"""
Negate an expression.
"""
not: GraphqlCallExpr
"""
Match a literal.
"""
literal: GraphqlCallLiteral
}
"""
GraphQL input representing the call literal.
"""
input GraphqlCallLiteral @oneOf {
"""
The call id option.
"""
callId: ID
"""
The channel id option.
"""
channelId: ID
"""
The speaker option.
"""
speaker: String
"""
The status option.
"""
status: GraphqlCallStatus
"""
The attended option.
"""
attended: Boolean
}
"""
Metadata for a started call.
"""
type GraphqlCallStartedMetadata {
"""
Channel name.
"""
channelName: String
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
GraphQL input representing the call status.
"""
enum GraphqlCallStatus {
"""
The attended option.
"""
ATTENDED
"""
The missed option.
"""
MISSED
"""
The unattended option.
"""
UNATTENDED
}
"""
Metadata for someone asking to join a channel the recipient participates in.
"""
type GraphqlChannelAccessRequestedMetadata {
"""
The attempt to join; its current outcome is served by the channel.
"""
requestId: ID!
"""
Channel type.
"""
channelType: GraphqlNotificationChannelType!
"""
Channel display name.
"""
channelName: String!
"""
Requester profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
GraphQL fields for authoritative channel activity.
"""
type GraphqlChannelActivity {
"""
Stable activity row identifier.
"""
id: ID!
"""
User who owns this activity row.
"""
userId: String!
"""
Channel associated with the activity.
"""
channelId: ID!
"""
Activity row creation time in RFC 3339 format.
"""
createdAt: String!
"""
Activity row update time in RFC 3339 format.
"""
updatedAt: String!
"""
Most recent channel view time in RFC 3339 format.
"""
viewedAt: String
"""
Most recent channel interaction time in RFC 3339 format.
"""
interactedAt: String
}
"""
The two operands of a recursive `ChannelFilterExpr` binary expression.
"""
input GraphqlChannelBinaryExpr {
"""
Left expression.
"""
left: GraphqlChannelExpr!
"""
Right expression.
"""
right: GraphqlChannelExpr!
}
"""
A recursive `ChannelFilterExpr` filter expression.
"""
input GraphqlChannelExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlChannelBinaryExpr
"""
Either expression may match.
"""
or: GraphqlChannelBinaryExpr
"""
Negate an expression.
"""
not: GraphqlChannelExpr
"""
Match a literal.
"""
literal: GraphqlChannelLiteral
}
"""
Metadata for a channel invitation.
"""
type GraphqlChannelInviteMetadata {
"""
Inviting user identifier.
"""
invitedBy: String!
"""
Channel name.
"""
channelName: String!
"""
Message content associated with the invitation.
"""
messageContent: String
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
GraphQL input representing the channel literal.
"""
input GraphqlChannelLiteral @oneOf {
"""
The thread id option.
"""
threadId: ID
"""
The mention option.
"""
mention: String
"""
The organization id option.
"""
organizationId: Int
"""
The team id option.
"""
teamId: ID
"""
The channel id option.
"""
channelId: ID
"""
The sender option.
"""
sender: String
"""
The channel type option.
"""
channelType: GraphqlChannelTypeFilter
"""
The importance option.
"""
importance: Boolean
"""
The is participant option. Filters by whether the requesting user is an
active participant; its presence widens the candidate set to team channels
of the user's teams they have not joined.
"""
isParticipant: Boolean
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
}
"""
Metadata for a channel mention notification.
"""
type GraphqlChannelMentionMetadata {
"""
Mentioning message identifier.
"""
messageId: String!
"""
Mentioning message content.
"""
messageContent: String!
"""
Whether the message has attachments.
"""
hasAttachments: Boolean!
"""
Thread identifier, when the mention is in a thread.
"""
threadId: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
"""
Channel type.
"""
channelType: GraphqlNotificationChannelType!
"""
Channel display name.
"""
channelName: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
Metadata for a reaction to a channel message.
"""
type GraphqlChannelMessageReactionMetadata {
"""
Reacted-to message identifier.
"""
messageId: String!
"""
Root thread identifier when the message is a reply.
"""
threadId: String
"""
Reacted-to message content.
"""
messageContent: String!
"""
Emoji added by the reactor.
"""
emoji: String!
"""
Channel type.
"""
channelType: GraphqlNotificationChannelType!
"""
Channel display name.
"""
channelName: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
Metadata for a newly sent channel message.
"""
type GraphqlChannelMessageSendMetadata {
"""
Sending user identifier.
"""
sender: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
"""
Message content.
"""
messageContent: String!
"""
Message identifier.
"""
messageId: String!
"""
Whether the message has attachments.
"""
hasAttachments: Boolean!
"""
Channel type.
"""
channelType: GraphqlNotificationChannelType!
"""
Channel display name.
"""
channelName: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
Channel role resolved for the current viewer.
"""
enum GraphqlChannelParticipantRole {
"""
Channel owner.
"""
OWNER
"""
Channel administrator.
"""
ADMIN
"""
Channel member.
"""
MEMBER
}
"""
Metadata for a reply to a channel thread.
"""
type GraphqlChannelReplyMetadata {
"""
Thread identifier.
"""
threadId: String!
"""
Reply message identifier.
"""
messageId: String!
"""
Replying user identifier.
"""
userId: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
"""
Reply content.
"""
messageContent: String!
"""
Whether the reply has attachments.
"""
hasAttachments: Boolean!
"""
Root-message sender identifier.
"""
threadParentSenderId: String
"""
Channel type.
"""
channelType: GraphqlNotificationChannelType!
"""
Channel display name.
"""
channelName: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
Channel permission represented by the viewer's participant role.
"""
type GraphqlChannelRolePermission {
"""
Channel participant role held by the viewer.
"""
role: GraphqlChannelParticipantRole!
}
"""
The two operands of a recursive `ChannelThreadFilterExpr` binary expression.
"""
input GraphqlChannelThreadBinaryExpr {
"""
Left expression.
"""
left: GraphqlChannelThreadExpr!
"""
Right expression.
"""
right: GraphqlChannelThreadExpr!
}
"""
A recursive `ChannelThreadFilterExpr` filter expression.
"""
input GraphqlChannelThreadExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlChannelThreadBinaryExpr
"""
Either expression may match.
"""
or: GraphqlChannelThreadBinaryExpr
"""
Negate an expression.
"""
not: GraphqlChannelThreadExpr
"""
Match a literal.
"""
literal: GraphqlChannelThreadLiteral
}
"""
GraphQL input representing the channel thread literal.
"""
input GraphqlChannelThreadLiteral @oneOf {
"""
The thread id option.
"""
threadId: ID
"""
The channel id option.
"""
channelId: ID
"""
The root sender option.
"""
rootSender: String
"""
The participant option.
"""
participant: String
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
"""
Whether the thread has at least one undeleted reply.
"""
hasReplies: Boolean
}
"""
GraphQL input representing the channel type filter.
"""
enum GraphqlChannelTypeFilter {
"""
The public option.
"""
PUBLIC
"""
The private option.
"""
PRIVATE
"""
The direct message option.
"""
DIRECT_MESSAGE
"""
The team option.
"""
TEAM
}
"""
View-only channel permission without participant membership.
"""
type GraphqlChannelViewOnlyPermission {
"""
Whether the viewer is limited to view-only channel access.
"""
isViewOnly: Boolean!
}
"""
The two operands of a recursive `ChatFilterExpr` binary expression.
"""
input GraphqlChatBinaryExpr {
"""
Left expression.
"""
left: GraphqlChatExpr!
"""
Right expression.
"""
right: GraphqlChatExpr!
}
"""
A recursive `ChatFilterExpr` filter expression.
"""
input GraphqlChatExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlChatBinaryExpr
"""
Either expression may match.
"""
or: GraphqlChatBinaryExpr
"""
Negate an expression.
"""
not: GraphqlChatExpr
"""
Match a literal.
"""
literal: GraphqlChatLiteral
}
"""
GraphQL input representing the chat literal.
"""
input GraphqlChatLiteral @oneOf {
"""
The project id option.
"""
projectId: ID
"""
The role option.
"""
role: GraphqlChatRole
"""
The chat id option.
"""
chatId: ID
"""
The owner principal option — a user (`macro|<email>`), a bot
(`bot|<uuid>`), or a team (a bare hyphenated uuid).
"""
owner: String
"""
The importance option.
"""
importance: Boolean
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
"""
The created at option.
"""
createdAt: GraphqlDateLiteral
"""
The updated at option.
"""
updatedAt: GraphqlDateLiteral
}
"""
GraphQL input representing the chat role.
"""
enum GraphqlChatRole {
"""
The user option.
"""
USER
"""
The system option.
"""
SYSTEM
"""
The assistant option.
"""
ASSISTANT
}
"""
Metadata for a comment on a document.
"""
type GraphqlCommentedOnDocumentMetadata {
"""
Document name.
"""
documentName: String!
"""
Document owner identifier.
"""
owner: String!
"""
Document file type.
"""
fileType: String
"""
Document subtype.
"""
subType: GraphqlNotificationDocumentSubType
"""
Comment identifier: a legacy numeric comment id, or the message id in
the shared message store.
"""
commentId: String!
"""
Comment thread identifier: a legacy numeric thread id, or the root
message id in the shared message store.
"""
threadId: String!
"""
Comment text.
"""
text: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
}
"""
GraphQL input naming the CRM record an association filter restricts to.
"""
input GraphqlCrmAssociation @oneOf {
"""
Items associated with the company or any of its contacts.
"""
company: ID
"""
Items associated with the contact.
"""
contact: ID
"""
Activity across visible CRM-enabled teams; only true is valid.
"""
activity: Boolean
}
"""
The two operands of a recursive `CrmCompanyFilterExpr` binary expression.
"""
input GraphqlCrmCompanyBinaryExpr {
"""
Left expression.
"""
left: GraphqlCrmCompanyExpr!
"""
Right expression.
"""
right: GraphqlCrmCompanyExpr!
}
"""
A recursive `CrmCompanyFilterExpr` filter expression.
"""
input GraphqlCrmCompanyExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlCrmCompanyBinaryExpr
"""
Either expression may match.
"""
or: GraphqlCrmCompanyBinaryExpr
"""
Negate an expression.
"""
not: GraphqlCrmCompanyExpr
"""
Match a literal.
"""
literal: GraphqlCrmCompanyLiteral
}
"""
GraphQL input representing the crm company literal.
"""
input GraphqlCrmCompanyLiteral @oneOf {
"""
The id option.
"""
id: ID
"""
The hidden option.
"""
hidden: Boolean
}
"""
The two operands of a recursive `CrmContactFilterExpr` binary expression.
"""
input GraphqlCrmContactBinaryExpr {
"""
Left expression.
"""
left: GraphqlCrmContactExpr!
"""
Right expression.
"""
right: GraphqlCrmContactExpr!
}
"""
A recursive `CrmContactFilterExpr` filter expression.
"""
input GraphqlCrmContactExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlCrmContactBinaryExpr
"""
Either expression may match.
"""
or: GraphqlCrmContactBinaryExpr
"""
Negate an expression.
"""
not: GraphqlCrmContactExpr
"""
Match a literal.
"""
literal: GraphqlCrmContactLiteral
}
"""
GraphQL contact predicates over authorized team records.
"""
input GraphqlCrmContactLiteral @oneOf {
"""
Include visible contacts. Must be true.
"""
include: Boolean
"""
Exact team-owned contact ID.
"""
id: ID
"""
Owning company ID.
"""
companyId: ID
"""
Owning team ID.
"""
teamId: ID
"""
Full email address, matched case-insensitively.
"""
email: String
"""
Literal name/email search text.
"""
search: String
"""
Effective hidden state, subject to the viewer's role on each team.
"""
hidden: Boolean
}
"""
Metadata for a discussion on a CRM company or contact.
"""
type GraphqlCrmDiscussionMetadata {
"""
Company or contact display name.
"""
recordName: String!
"""
Notification reason.
"""
reason: GraphqlCrmDiscussionReason!
"""
Shared message identifier.
"""
messageId: ID!
"""
Shared discussion root identifier.
"""
threadId: ID!
"""
Comment Markdown.
"""
text: String!
"""
Public bot display name, if applicable.
"""
senderDisplayName: String
"""
Sender avatar URL.
"""
senderProfilePictureUrl: String
}
"""
Why a CRM discussion notification was sent.
"""
enum GraphqlCrmDiscussionReason {
"""
Explicit user mention.
"""
MENTION
"""
Reply to a discussion.
"""
REPLY
"""
Comment on an owned company or one of its contacts.
"""
OWNER
}
"""
A CRM pipeline the viewer can see.
"""
type GraphqlCrmPipeline {
"""
The pipeline's identifier.
"""
id: ID!
"""
The pipeline's name.
"""
name: String!
"""
Which CRM record its rows reference.
"""
recordType: GraphqlCrmPipelineRecordType!
"""
Whether the pipeline is shared with its team.
"""
sharing: GraphqlCrmPipelineSharing!
"""
The table that pipeline operations name.
"""
tableId: ID!
"""
Whether the viewer may edit the pipeline's rows.
"""
canEdit: Boolean!
}
"""
One cell of a pipeline row.
"""
type GraphqlCrmPipelineCell {
"""
The cell's column.
"""
column: GraphqlCrmPipelineColumn!
"""
The cell's value, absent when the cell is empty.
"""
value: GraphqlPropertyValue
}
"""
A pipeline column, with what its cells' values mean.
"""
type GraphqlCrmPipelineColumn {
"""
The column's identifier.
"""
id: ID!
"""
The property definition the column binds.
"""
propertyDefinitionId: ID!
"""
The column's name.
"""
name: String!
"""
The type of value the column holds.
"""
dataType: GraphqlPropertyDataType!
"""
Whether a cell can hold more than one value; a relation always can.
"""
isMultiSelect: Boolean!
"""
Whether the column's cells take writes; derived columns are computed.
"""
writable: Boolean!
"""
The required entity type for a reference column, when constrained.
"""
specificEntityType: GraphqlPropertyEntityType
"""
The options a select column's cells choose from, in display order.
"""
options: [GraphqlPropertyOption!]!
}
"""
A pipeline row that references a company or contact.
"""
type GraphqlCrmPipelineEntry {
"""
The row's identifier.
"""
id: ID!
"""
The pipeline holding the row.
"""
pipeline: GraphqlCrmPipeline!
"""
The row's cells in column order, for every column but the reference
to the record itself. An empty cell has no value.
"""
cells: [GraphqlCrmPipelineCell!]!
}
"""
Which CRM record a pipeline's rows reference.
"""
enum GraphqlCrmPipelineRecordType {
"""
Companies.
"""
COMPANY
"""
Contacts.
"""
CONTACT
}
"""
Whether a pipeline is shared with its team.
"""
enum GraphqlCrmPipelineSharing {
"""
Only people granted access individually.
"""
PRIVATE
"""
The whole team may edit.
"""
TEAM
}
"""
GraphQL input representing the crm scope.
"""
input GraphqlCrmScope @oneOf {
"""
The domains option.
"""
domains: [String!]
"""
The addresses option.
"""
addresses: [String!]
}
"""
The two operands of a recursive `DatabaseRowFilterExpr` binary expression.
"""
input GraphqlDatabaseRowBinaryExpr {
"""
Left expression.
"""
left: GraphqlDatabaseRowExpr!
"""
Right expression.
"""
right: GraphqlDatabaseRowExpr!
}
"""
A recursive `DatabaseRowFilterExpr` filter expression.
"""
input GraphqlDatabaseRowExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlDatabaseRowBinaryExpr
"""
Either expression may match.
"""
or: GraphqlDatabaseRowBinaryExpr
"""
Negate an expression.
"""
not: GraphqlDatabaseRowExpr
"""
Match a literal.
"""
literal: GraphqlDatabaseRowLiteral
}
"""
GraphQL input for selecting database rows through Soup.
"""
input GraphqlDatabaseRowLiteral @oneOf {
"""
Include accessible rows of every table; must be true.
"""
include: Boolean
"""
Match the rows of a table.
"""
tableId: ID
"""
Match one row.
"""
id: ID
}
"""
One named half-open UTC interval.
"""
input GraphqlDateBucketRange {
"""
Unique group key.
"""
key: String!
"""
Inclusive RFC 3339 UTC start; null means negative infinity.
"""
start: String
"""
Exclusive RFC 3339 UTC end; null means positive infinity.
"""
end: String
}
"""
GraphQL input representing the date literal.
"""
input GraphqlDateLiteral @oneOf {
"""
The gt option.
"""
gt: String
"""
The lt option.
"""
lt: String
"""
The gte option.
"""
gte: String
"""
The lte option.
"""
lte: String
}
"""
A date-time property value.
"""
type GraphqlDatePropertyValue {
"""
The stored date-time formatted as RFC 3339.
"""
value: String!
}
"""
A date range accepted when setting an entity property.
"""
input GraphqlDateRangeInput {
"""
Where the range starts, as an RFC 3339 date-time.
"""
start: String!
"""
Where the range ends, as an RFC 3339 date-time no earlier than the start.
"""
end: String!
}
"""
A date-range property value.
"""
type GraphqlDateRangePropertyValue {
"""
Where the range starts, formatted as RFC 3339.
"""
start: String!
"""
Where the range ends, formatted as RFC 3339; never before the start.
"""
end: String!
}
"""
The two operands of a recursive `DocumentFilterExpr` binary expression.
"""
input GraphqlDocumentBinaryExpr {
"""
Left expression.
"""
left: GraphqlDocumentExpr!
"""
Right expression.
"""
right: GraphqlDocumentExpr!
}
"""
A recursive `DocumentFilterExpr` filter expression.
"""
input GraphqlDocumentExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlDocumentBinaryExpr
"""
Either expression may match.
"""
or: GraphqlDocumentBinaryExpr
"""
Negate an expression.
"""
not: GraphqlDocumentExpr
"""
Match a literal.
"""
literal: GraphqlDocumentLiteral
}
"""
GraphQL input representing the document literal.
"""
input GraphqlDocumentLiteral @oneOf {
"""
The file type option.
"""
fileType: String
"""
The id option.
"""
id: ID
"""
The project id option.
"""
projectId: ID
"""
The owner principal option — a user (`macro|<email>`), a bot
(`bot|<uuid>`), or a team (a bare hyphenated uuid).
"""
owner: String
"""
The importance option.
"""
importance: Boolean
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
"""
The include cbm atm nc option.
"""
includeCbmAtmNc: Boolean
"""
The sub type option.
"""
subType: GraphqlDocumentSubType
"""
The file assoc option.
"""
fileAssoc: String
"""
The is email attachment option.
"""
isEmailAttachment: Boolean
"""
The created at option.
"""
createdAt: GraphqlDateLiteral
"""
The updated at option.
"""
updatedAt: GraphqlDateLiteral
"""
An entity-property condition on the document or task.
"""
property: GraphqlFilterPropertiesLiteral
"""
Uploaded from an email attachment sent by, or to, a matching address.
"""
emailAttachmentParticipant: GraphqlEmailValue
"""
Associated with a CRM record through its Companies or Contacts
property or a reference to the record. Requires an expanded query
sorted by a timestamp or task due date.
"""
crmAssociated: GraphqlCrmAssociation
"""
Case-insensitive substring of the document name.
"""
nameContains: String
}
"""
Metadata for a document mention notification.
"""
type GraphqlDocumentMentionMetadata {
"""
Mentioned document name.
"""
documentName: String!
"""
Document owner identifier.
"""
owner: String!
"""
Document file type.
"""
fileType: String
"""
Document subtype.
"""
subType: GraphqlNotificationDocumentSubType
"""
Mentioning message identifier.
"""
messageId: String!
"""
Mentioning message content.
"""
messageContent: String!
"""
Whether the message has attachments.
"""
hasAttachments: Boolean!
"""
Thread identifier, when the mention is in a thread.
"""
threadId: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
"""
Channel type.
"""
channelType: GraphqlNotificationChannelType!
"""
Channel display name.
"""
channelName: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
GraphQL input representing the document sub type.
"""
enum GraphqlDocumentSubType {
"""
The task option.
"""
TASK
"""
The snippet option.
"""
SNIPPET
"""
The skill option.
"""
SKILL
"""
The initiative description option.
"""
INITIATIVE_DESCRIPTION
}
"""
The two operands of a recursive `EmailFilterExpr` binary expression.
"""
input GraphqlEmailBinaryExpr {
"""
Left expression.
"""
left: GraphqlEmailExpr!
"""
Right expression.
"""
right: GraphqlEmailExpr!
}
"""
A recursive `EmailFilterExpr` filter expression.
"""
input GraphqlEmailExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlEmailBinaryExpr
"""
Either expression may match.
"""
or: GraphqlEmailBinaryExpr
"""
Negate an expression.
"""
not: GraphqlEmailExpr
"""
Match a literal.
"""
literal: GraphqlEmailLiteral
}
"""
GraphQL input representing the email filter ast.
"""
input GraphqlEmailFilterAst {
"""
The tree.
"""
tree: GraphqlEmailExpr
"""
The crm scope.
"""
crmScope: GraphqlCrmScope
}
"""
Why a thread is in or out of Focus.
"""
enum GraphqlEmailFocusCategory {
"""
A customer, client or user asking for help or giving feedback.
"""
CUSTOMER
"""
Mail from someone at the owner's own company.
"""
TEAM
"""
Mail from someone the owner corresponds with.
"""
KNOWN
"""
Relevant mail that fits no narrower category.
"""
OTHER
"""
In Focus, a reschedule, update, cancellation or proposed new time for an
event that isn't over. Left out, a new invite or an RSVP notice.
"""
CALENDAR
"""
Unsolicited outreach: a pitch, recruiting or a job application.
"""
OUTREACH
"""
Automated, bulk or templated mail.
"""
AUTOMATED
"""
Nothing marks the thread as relevant.
"""
LOW_RELEVANCE
}
"""
Which way a thread's importance is moving.
"""
enum GraphqlEmailImportanceTrend {
"""
Rising, towards 100.
"""
UP
"""
Falling, towards 0.
"""
DOWN
"""
Not moving.
"""
FLAT
}
"""
Enriched email link accessible to the authenticated user.
"""
type GraphqlEmailLink {
"""
Whether drafts from this account's own sender are classified as Signal.
"""
draftIsSignal: Boolean!
"""
Stable email link identifier.
"""
id: ID!
"""
Macro user that owns the inbox.
"""
macroId: String!
"""
Provider email address for the inbox.
"""
emailAddress: String!
"""
SFS URL of the inbox's self-contact photo, when available.
"""
photoUrl: String
"""
Email provider.
"""
provider: GraphqlEmailProvider!
"""
Whether ongoing provider synchronization is enabled.
"""
isSyncActive: Boolean!
"""
Coarse synchronization state derived by the email domain.
"""
syncStatus: GraphqlEmailSyncStatus!
"""
Whether the provider grant must be reauthorized.
"""
needsReauth: Boolean!
"""
Inbox signature settings.
"""
settings: GraphqlEmailLinkSettings!
"""
Whether this is the owner's primary inbox.
"""
isPrimary: Boolean!
"""
Whether the recorded Google grant lacks the calendar capability.
"""
needsCalendarPermission: Boolean!
"""
Whether the owner turned the inbox's calendar off.
"""
calendarDisabled: Boolean!
"""
Whether a calendar account has been provisioned for the inbox.
"""
hasCalendarData: Boolean!
"""
Link creation timestamp in RFC 3339 format.
"""
createdAt: String!
"""
Link last-updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
Verified sender addresses. Nullable so one unavailable grant does not
hide the inbox or aliases belonging to other inboxes.
"""
sendAs: [GraphqlEmailSendAsAddress!]
}
"""
Signature settings embedded in an authenticated user's email link.
"""
type GraphqlEmailLinkSettings {
"""
Whether signatures are included on replies and forwards.
"""
signatureOnRepliesForwards: Boolean!
"""
Saved, sanitized signature HTML, when configured.
"""
signature: String
}
"""
GraphQL input representing the email literal.
"""
input GraphqlEmailLiteral @oneOf {
"""
The sender option.
"""
sender: GraphqlEmailValue
"""
The cc option.
"""
cc: GraphqlEmailValue
"""
The bcc option.
"""
bcc: GraphqlEmailValue
"""
The recipient option.
"""
recipient: GraphqlEmailValue
"""
The thread id option.
"""
threadId: ID
"""
The owner option.
"""
owner: ID
"""
The project id option.
"""
projectId: String
"""
The importance option.
"""
importance: Boolean
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
"""
The email thread read flag, independent of notification state.
"""
read: Boolean
"""
Inbox visibility: false selects archived (done) mail, independently of notifications.
"""
inboxVisible: Boolean
"""
The shared option.
"""
shared: GraphqlSharedEmailFilter
"""
The calendar only option.
"""
calendarOnly: Boolean
"""
The created at option.
"""
createdAt: GraphqlDateLiteral
"""
The updated at option.
"""
updatedAt: GraphqlDateLiteral
"""
The per-viewer viewed at option.
"""
viewedAt: GraphqlDateLiteral
}
"""
Email provider for an authenticated user's linked inbox.
"""
enum GraphqlEmailProvider {
"""
Google Gmail.
"""
GMAIL
"""
Microsoft Outlook and Microsoft 365.
"""
OUTLOOK
}
"""
A verified provider sender, embedded under the inbox that authorizes it.
An address alone is not a global identity: two inboxes may send as it.
"""
type GraphqlEmailSendAsAddress {
"""
Address to use in the outgoing From header.
"""
emailAddress: String!
"""
Provider-configured display name.
"""
displayName: String
}
"""
Coarse synchronization state for an authenticated user's linked inbox.
"""
enum GraphqlEmailSyncStatus {
"""
Initial synchronization is queued or running.
"""
SYNCING
"""
The inbox is active and synchronized.
"""
UP_TO_DATE
"""
Initial synchronization failed or was cancelled.
"""
ERROR
"""
The provider grant must be reauthorized.
"""
NEEDS_REAUTH
"""
Synchronization is disabled.
"""
INACTIVE
}
"""
The Focus classification of one email thread.
"""
type GraphqlEmailThreadFocus {
"""
Whether the thread belongs in Focus.
"""
isFocus: Boolean!
"""
The Focus category, or why the thread was left out.
"""
category: GraphqlEmailFocusCategory!
"""
How much the thread matters right now, 0 to 100.
"""
importance: Int!
"""
Someone else sent the latest message and it waits on the owner's answer.
Never true together with `needs_follow_up`.
"""
needsReply: Boolean!
"""
The owner sent the latest message and should come back to the thread: it
has an open loop or has waited for an answer. Never true together with
`needs_reply`.
"""
needsFollowUp: Boolean!
"""
When the classification was made, in RFC 3339 format.
"""
classifiedAt: String!
"""
Which way `importance` is moving.
"""
importanceTrend: GraphqlEmailImportanceTrend!
"""
The day the thread's mail says it is due, as `YYYY-MM-DD`: a calendar date
the viewer's time zone never shifts. Absent when it names no open deadline.
"""
dueOn: String
}
"""
GraphQL input representing the email value.
"""
input GraphqlEmailValue @oneOf {
"""
The partial option.
"""
partial: String
"""
The complete option.
"""
complete: String
"""
The domain option.
"""
domain: String
}
"""
GraphQL input representing the email view.
"""
enum GraphqlEmailView {
"""
The inbox option.
"""
INBOX
"""
The drafts option.
"""
DRAFTS
"""
The sent option.
"""
SENT
"""
The all option.
"""
ALL
"""
The starred option.
"""
STARRED
"""
The important option.
"""
IMPORTANT
"""
The other option.
"""
OTHER
}
"""
Canonical reference to an entity.
"""
type GraphqlEntity {
"""
The entity's canonical identifier.
"""
id: ID!
"""
The entity's canonical type.
"""
entityType: GraphqlEntityType!
}
"""
Metadata for an approved access request and its granted permission.
"""
type GraphqlEntityAccessGrantedMetadata {
"""
Stable access request id.
"""
requestId: ID!
"""
Request revision.
"""
revision: Int!
"""
Entity display name.
"""
entityName: String!
"""
Document file extension, when applicable.
"""
fileType: String
"""
Requested or granted access.
"""
accessLevel: String!
}
"""
Item access level resolved for the current viewer.
"""
enum GraphqlEntityAccessLevel {
"""
Read-only access.
"""
VIEW
"""
Comment access.
"""
COMMENT
"""
Edit access.
"""
EDIT
"""
Owner access.
"""
OWNER
}
"""
Metadata for a request to view, comment on, or edit a shared item.
"""
type GraphqlEntityAccessRequestedMetadata {
"""
Stable access request id.
"""
requestId: ID!
"""
Request revision.
"""
revision: Int!
"""
Entity display name.
"""
entityName: String!
"""
Document file extension, when applicable.
"""
fileType: String
"""
Requested or granted access.
"""
accessLevel: String!
}
"""
GraphQL input mirroring `item_filters::ast::EntityFilterAst`.
"""
input GraphqlEntityFilterAst {
"""
Restrict results to the authenticated viewer's favorites when true.
"""
favoritesOnly: Boolean
"""
Restrict every entity type to items associated with this CRM record,
or to activity across visible CRM-enabled teams.
Requires an expanded query sorted by a timestamp or selected property.
"""
crmAssociation: GraphqlCrmAssociation
"""
The calendar event filter to apply.
"""
calendarEventFilter: GraphqlCalendarEventExpr
"""
The document filter to apply.
"""
documentFilter: GraphqlDocumentExpr
"""
The project filter to apply.
"""
projectFilter: GraphqlProjectExpr
"""
The chat filter to apply.
"""
chatFilter: GraphqlChatExpr
"""
The email filter to apply.
"""
emailFilter: GraphqlEmailFilterAst
"""
The channel filter to apply.
"""
channelFilter: GraphqlChannelExpr
"""
The channel thread filter to apply.
"""
channelThreadFilter: GraphqlChannelThreadExpr
"""
The call filter to apply.
"""
callFilter: GraphqlCallExpr
"""
The crm company filter to apply.
"""
crmCompanyFilter: GraphqlCrmCompanyExpr
"""
Opt-in CRM contact filters, applied before contacts are collapsed by
normalized email address.
"""
crmContactFilter: GraphqlCrmContactExpr
"""
The foreign entity filter to apply.
"""
foreignEntityFilter: GraphqlForeignEntityExpr
"""
The GitHub pull request filter to apply, on top of the foreign entity filter.
"""
githubPullRequestFilter: GraphqlGithubPullRequestExpr
"""
Ignored: Soup no longer returns reminders.
"""
reminderFilter: GraphqlReminderExpr @deprecated(reason: "Soup no longer returns reminders (#7536). Remove after 2026-11-30.")
"""
The agent session filter to apply.
"""
agentSessionFilter: GraphqlAgentSessionExpr
"""
The initiative filter to apply. Initiatives are opt-in.
"""
initiativeFilter: GraphqlInitiativeExpr
"""
The database row filter to apply. Rows are opt-in: name a table.
"""
databaseRowFilter: GraphqlDatabaseRowExpr
"""
The properties filter to apply.
"""
propertiesFilter: GraphqlFilterPropertiesExpr
}
"""
Metadata shared by every canonical Soup entity.
"""
type GraphqlEntityMetadata {
"""
Owning principal, when applicable.
"""
ownerId: String
"""
The kind of principal `ownerId` names. Null exactly when `ownerId`
is, for the entities that have no owner of their own.
"""
ownerType: GraphqlOwnerType
"""
Parent project, channel, or team, when applicable.
"""
parent: GraphqlEntity
"""
Creation timestamp in RFC 3339 form.
"""
createdAt: String
"""
Last-update timestamp in RFC 3339 form.
"""
updatedAt: String
"""
Last-viewed timestamp in RFC 3339 form.
"""
viewedAt: String
"""
Soft-deletion timestamp in RFC 3339 form.
"""
deletedAt: String
}
"""
Stable machine-readable mutation error code.
"""
enum GraphqlEntityMutationErrorCode {
"""
Operation is unavailable for the requested entity kind.
"""
UNSUPPORTED_OPERATION
"""
Input violates a domain constraint.
"""
INVALID_INPUT
"""
Actor lacks the required capability.
"""
FORBIDDEN
"""
Entity was not found.
"""
NOT_FOUND
"""
Mutation conflicts with current state.
"""
CONFLICT
"""
Internal failure.
"""
INTERNAL
}
"""
Result for one requested entity in a batch.
"""
union GraphqlEntityMutationResult = GraphqlMutationSuccess | GraphqlMutationError
"""
Permission held by the current viewer for an entity.
The concrete union member identifies whether access comes from an item
access level, view-only channel access, a channel role, or a team role.
"""
union GraphqlEntityPermission = GraphqlAccessLevelPermission | GraphqlChannelViewOnlyPermission | GraphqlChannelRolePermission | GraphqlTeamRolePermission
"""
Input identifying an entity referenced by a property value.
"""
input GraphqlEntityReferenceInput {
"""
Type of the referenced entity.
"""
entityType: GraphqlPropertyEntityType!
"""
Identifier of the referenced entity.
"""
entityId: String!
"""
Specific message when the reference targets a thread message.
"""
specificMessageId: ID
}
"""
An entity-reference property value.
"""
type GraphqlEntityReferencePropertyValue {
"""
The referenced entities.
"""
references: [GraphqlPropertyEntityReference!]!
}
"""
Canonical entity types accepted by cross-entity APIs.
"""
enum GraphqlEntityType {
"""
CRM pipeline entity.
"""
CRM_PIPELINE
"""
Document entity.
"""
DOCUMENT
"""
Chat entity.
"""
CHAT
"""
Project entity.
"""
PROJECT
"""
Email thread entity.
"""
EMAIL_THREAD
"""
Channel entity.
"""
CHANNEL
"""
Channel message entity.
"""
CHANNEL_MESSAGE
"""
Call entity.
"""
CALL
"""
Calendar event entity.
"""
CALENDAR_EVENT
"""
CRM company entity.
"""
CRM_COMPANY
"""
Foreign entity.
"""
FOREIGN_ENTITY
"""
User entity.
"""
USER
"""
Team entity.
"""
TEAM
"""
Static file entity.
"""
STATIC_FILE
"""
CRM contact entity.
"""
CRM_CONTACT
"""
Reminder entity.
"""
REMINDER
"""
AI skill entity (skill document or built-in system skill).
"""
SKILL
"""
AI coding agent session entity.
"""
AGENT_SESSION
"""
Scheduled action entity.
"""
SCHEDULED_ACTION
"""
Initiative entity.
"""
INITIATIVE
"""
Macro Database entity (a collection of user-defined tables).
"""
DATABASE
"""
Row of a Macro Database table.
"""
DATABASE_ROW
"""
Macro Form entity (a questionnaire answered into a database table).
"""
FORM
"""
Independently shared external chat.
"""
EXTERNAL_CHAT
"""
Schema-only stub for clients released with this value before external
chats replaced WhatsApp groups. Never returned; rejected as input.
"""
WHATSAPP_GROUP @deprecated(reason: "Use EXTERNAL_CHAT. Never returned; rejected as input. Remove after 2026-11-30.")
}
"""
The mutually exclusive time shape of an event or occurrence.
"""
union GraphqlEventTime = GraphqlTimedEventTime | GraphqlAllDayEventTime
"""
Metadata for a message in an independently shared external chat.
"""
type GraphqlExternalChatMessageMetadata {
"""
The messaging service the chat lives in (`whatsapp`).
"""
provider: String!
"""
Display name of the chat.
"""
chatName: String!
"""
Message to open within the chat.
"""
messageId: ID!
}
"""
GraphQL fields for an ordered favorite.
"""
type GraphqlFavorite {
"""
Stable cache identity within the authenticated user's favorites collection.
"""
id: ID!
"""
Canonical type of the favorited entity.
"""
entityType: GraphqlEntityType!
"""
Canonical identifier of the favorited entity.
"""
entityId: ID!
"""
Manual ordering value; lower values sort first.
"""
sortOrder: Float!
"""
Time at which the entity was first favorited, in RFC 3339 format.
"""
createdAt: String!
"""
File type of a favorited document, when applicable.
"""
fileType: String
"""
Document subtype of a favorited document, when applicable.
"""
documentSubType: String
"""
Channel type of a favorited channel, when applicable.
"""
channelType: String
"""
Owning channel id of a favorited channel message, when applicable.
"""
channelId: ID
}
"""
The two operands of a recursive `PropertiesFilterExpr` binary expression.
"""
input GraphqlFilterPropertiesBinaryExpr {
"""
Left expression.
"""
left: GraphqlFilterPropertiesExpr!
"""
Right expression.
"""
right: GraphqlFilterPropertiesExpr!
}
"""
A recursive `PropertiesFilterExpr` filter expression.
"""
input GraphqlFilterPropertiesExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlFilterPropertiesBinaryExpr
"""
Either expression may match.
"""
or: GraphqlFilterPropertiesBinaryExpr
"""
Negate an expression.
"""
not: GraphqlFilterPropertiesExpr
"""
Match a literal.
"""
literal: GraphqlFilterPropertiesLiteral
}
"""
GraphQL input for matching a property value on an entity.
"""
input GraphqlFilterPropertiesLiteral {
"""
Property definition id to match.
"""
propertyDefinitionId: ID!
"""
Optional entity type scope for the property match.
"""
entityType: GraphqlPropertyEntityType
"""
Value to compare against the property.
"""
value: GraphqlFilterPropertyMatchValue!
}
"""
GraphQL input value used when matching a property.
"""
input GraphqlFilterPropertyMatchValue @oneOf {
"""
Select option id to match.
"""
selectOption: ID
"""
Entity reference id to match.
"""
entityRef: ID
"""
Match a DATE property in a UTC range.
"""
dateRange: GraphqlPropertyDateRange
}
"""
The two operands of a recursive `ForeignEntityFilterExpr` binary expression.
"""
input GraphqlForeignEntityBinaryExpr {
"""
Left expression.
"""
left: GraphqlForeignEntityExpr!
"""
Right expression.
"""
right: GraphqlForeignEntityExpr!
}
"""
A recursive `ForeignEntityFilterExpr` filter expression.
"""
input GraphqlForeignEntityExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlForeignEntityBinaryExpr
"""
Either expression may match.
"""
or: GraphqlForeignEntityBinaryExpr
"""
Negate an expression.
"""
not: GraphqlForeignEntityExpr
"""
Match a literal.
"""
literal: GraphqlForeignEntityLiteral
}
"""
GraphQL input representing the foreign entity literal.
"""
input GraphqlForeignEntityLiteral @oneOf {
"""
The id option.
"""
id: ID
"""
The foreign entity id option.
"""
foreignEntityId: String
"""
The foreign entity source option.
"""
foreignEntitySource: String
"""
The includes me option.
"""
includesMe: Boolean
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
}
"""
Metadata for a completed GitHub pull-request check run.
"""
type GraphqlGithubPrCheckRunMetadata {
"""
Internal foreign-entity identifier.
"""
foreignEntityId: ID!
"""
External GitHub key.
"""
githubKey: String!
"""
Repository owner or organization.
"""
owner: String!
"""
Repository name.
"""
repo: String!
"""
Pull-request number.
"""
number: String!
"""
Public pull-request URL.
"""
url: String!
"""
Compact pull-request display label.
"""
displayName: String!
"""
Pull-request title.
"""
title: String!
"""
Sender GitHub login.
"""
senderGithubLogin: String
"""
Sender GitHub user identifier.
"""
senderGithubUserId: String
"""
Sender GitHub avatar URL.
"""
senderGithubAvatarUrl: String
"""
Check-run GitHub identifier.
"""
checkRunGithubId: ID!
"""
Check name.
"""
checkName: String!
"""
Raw check status.
"""
checkStatus: String!
"""
Raw check conclusion.
"""
conclusion: String!
"""
Normalized check state.
"""
state: GraphqlGithubPrCheckRunState!
"""
Public check URL.
"""
checkUrl: String!
"""
Completion timestamp in RFC 3339 format.
"""
completedAt: String!
}
"""
GraphQL GitHub check-run state.
"""
enum GraphqlGithubPrCheckRunState {
"""
Check completed successfully.
"""
COMPLETED
"""
Check completed with a failure-like result.
"""
FAILED
}
"""
GraphQL GitHub pull-request comment kind.
"""
enum GraphqlGithubPrCommentKind {
"""
Top-level issue comment.
"""
ISSUE
"""
Inline review comment.
"""
REVIEW_COMMENT
}
"""
Metadata for a GitHub pull-request comment.
"""
type GraphqlGithubPrCommentMetadata {
"""
Internal foreign-entity identifier.
"""
foreignEntityId: ID!
"""
External GitHub key.
"""
githubKey: String!
"""
Repository owner or organization.
"""
owner: String!
"""
Repository name.
"""
repo: String!
"""
Pull-request number.
"""
number: String!
"""
Public pull-request URL.
"""
url: String!
"""
Compact pull-request display label.
"""
displayName: String!
"""
Pull-request title.
"""
title: String!
"""
Sender GitHub login.
"""
senderGithubLogin: String
"""
Sender GitHub user identifier.
"""
senderGithubUserId: String
"""
Sender GitHub avatar URL.
"""
senderGithubAvatarUrl: String
"""
Comment kind.
"""
commentKind: GraphqlGithubPrCommentKind!
"""
Comment GitHub identifier.
"""
commentGithubId: ID
"""
Public comment URL.
"""
commentUrl: String
"""
Truncated comment body.
"""
commentSnippet: String!
}
"""
GraphQL GitHub pull-request action.
"""
enum GraphqlGithubPrEventAction {
"""
Pull request opened.
"""
OPENED
"""
Pull request reopened.
"""
REOPENED
"""
Pull request closed.
"""
CLOSED
}
"""
GraphQL GitHub pull-request lifecycle status.
"""
enum GraphqlGithubPrEventStatus {
"""
Open pull request.
"""
OPEN
"""
Closed pull request.
"""
CLOSED
"""
Merged pull request.
"""
MERGED
}
"""
GraphQL location of a GitHub pull-request mention.
"""
enum GraphqlGithubPrMentionLocation {
"""
Pull-request body.
"""
PR_BODY
"""
Top-level comment.
"""
COMMENT
"""
Review summary.
"""
REVIEW
"""
Inline review comment.
"""
REVIEW_COMMENT
}
"""
Metadata for a GitHub pull-request mention.
"""
type GraphqlGithubPrMentionMetadata {
"""
Internal foreign-entity identifier.
"""
foreignEntityId: ID!
"""
External GitHub key.
"""
githubKey: String!
"""
Repository owner or organization.
"""
owner: String!
"""
Repository name.
"""
repo: String!
"""
Pull-request number.
"""
number: String!
"""
Public pull-request URL.
"""
url: String!
"""
Compact pull-request display label.
"""
displayName: String!
"""
Pull-request title.
"""
title: String!
"""
Sender GitHub login.
"""
senderGithubLogin: String
"""
Sender GitHub user identifier.
"""
senderGithubUserId: String
"""
Sender GitHub avatar URL.
"""
senderGithubAvatarUrl: String
"""
Mention location.
"""
location: GraphqlGithubPrMentionLocation!
"""
Comment or review GitHub identifier.
"""
commentGithubId: ID
"""
Public URL for the mentioning text.
"""
commentUrl: String
"""
Truncated mentioning text.
"""
textSnippet: String!
}
"""
Metadata for a GitHub pull-request review.
"""
type GraphqlGithubPrReviewMetadata {
"""
Internal foreign-entity identifier.
"""
foreignEntityId: ID!
"""
External GitHub key.
"""
githubKey: String!
"""
Repository owner or organization.
"""
owner: String!
"""
Repository name.
"""
repo: String!
"""
Pull-request number.
"""
number: String!
"""
Public pull-request URL.
"""
url: String!
"""
Compact pull-request display label.
"""
displayName: String!
"""
Pull-request title.
"""
title: String!
"""
Sender GitHub login.
"""
senderGithubLogin: String
"""
Sender GitHub user identifier.
"""
senderGithubUserId: String
"""
Sender GitHub avatar URL.
"""
senderGithubAvatarUrl: String
"""
Review GitHub identifier.
"""
reviewGithubId: ID
"""
Public review URL.
"""
reviewUrl: String
"""
Review state.
"""
state: GraphqlGithubPrReviewState!
"""
Truncated review body.
"""
reviewSnippet: String
}
"""
GraphQL state of a GitHub pull-request review.
"""
enum GraphqlGithubPrReviewState {
"""
Review approved the pull request.
"""
APPROVED
"""
Review requested changes.
"""
CHANGES_REQUESTED
"""
Review left comments without an approval decision.
"""
COMMENTED
}
"""
Metadata for a GitHub pull-request lifecycle change.
"""
type GraphqlGithubPrStatusChangedMetadata {
"""
Internal foreign-entity identifier.
"""
foreignEntityId: ID!
"""
External GitHub key.
"""
githubKey: String!
"""
Repository owner or organization.
"""
owner: String!
"""
Repository name.
"""
repo: String!
"""
Pull-request number.
"""
number: String!
"""
Public pull-request URL.
"""
url: String!
"""
Compact pull-request display label.
"""
displayName: String!
"""
Pull-request title.
"""
title: String!
"""
Sender GitHub login.
"""
senderGithubLogin: String
"""
Sender GitHub user identifier.
"""
senderGithubUserId: String
"""
Sender GitHub avatar URL.
"""
senderGithubAvatarUrl: String
"""
Current pull-request status.
"""
status: GraphqlGithubPrEventStatus!
"""
Triggering webhook action.
"""
action: GraphqlGithubPrEventAction!
"""
Previous pull-request status.
"""
previousStatus: GraphqlGithubPrEventStatus
"""
Head branch.
"""
headBranch: String
"""
Base branch.
"""
baseBranch: String
"""
Merge timestamp in RFC 3339 format.
"""
mergedAt: String
}
"""
The two operands of a recursive `GithubPullRequestFilterExpr` binary expression.
"""
input GraphqlGithubPullRequestBinaryExpr {
"""
Left expression.
"""
left: GraphqlGithubPullRequestExpr!
"""
Right expression.
"""
right: GraphqlGithubPullRequestExpr!
}
"""
A recursive `GithubPullRequestFilterExpr` filter expression.
"""
input GraphqlGithubPullRequestExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlGithubPullRequestBinaryExpr
"""
Either expression may match.
"""
or: GraphqlGithubPullRequestBinaryExpr
"""
Negate an expression.
"""
not: GraphqlGithubPullRequestExpr
"""
Match a literal.
"""
literal: GraphqlGithubPullRequestLiteral
}
"""
GraphQL input representing a GitHub pull request literal.
"""
input GraphqlGithubPullRequestLiteral @oneOf {
"""
The numeric GitHub repository id option.
"""
repositoryId: String
"""
The author's numeric GitHub user id option.
"""
author: String
"""
The pull request state option.
"""
status: GraphqlGithubPullRequestState
"""
The numeric GitHub user id of someone involved in the pull request.
"""
involves: String
"""
The numeric GitHub user id of a requested reviewer.
"""
reviewRequested: String
"""
The draft option.
"""
draft: Boolean
"""
The numeric GitHub user id of an assignee.
"""
assignee: String
"""
The label name option.
"""
label: String
"""
The review status option.
"""
reviewStatus: GraphqlGithubPullRequestReviewStatus
"""
The numeric GitHub user id of someone who submitted a review.
"""
reviewedBy: String
}
"""
GraphQL input representing a GitHub pull request review status.
"""
enum GraphqlGithubPullRequestReviewStatus {
"""
The no reviews option.
"""
NONE
"""
The review required option.
"""
REQUIRED
"""
The approved option.
"""
APPROVED
"""
The changes requested option.
"""
CHANGES_REQUESTED
}
"""
GraphQL input representing a GitHub pull request state.
"""
enum GraphqlGithubPullRequestState {
"""
The open option.
"""
OPEN
"""
The closed option.
"""
CLOSED
"""
The merged option.
"""
MERGED
}
"""
Metadata for a GitHub pull-request review request.
"""
type GraphqlGithubReviewRequestedMetadata {
"""
Internal foreign-entity identifier.
"""
foreignEntityId: ID!
"""
External GitHub key.
"""
githubKey: String!
"""
Repository owner or organization.
"""
owner: String!
"""
Repository name.
"""
repo: String!
"""
Pull-request number.
"""
number: String!
"""
Public pull-request URL.
"""
url: String!
"""
Compact pull-request display label.
"""
displayName: String!
"""
Pull-request title.
"""
title: String!
"""
Sender GitHub login.
"""
senderGithubLogin: String
"""
Sender GitHub user identifier.
"""
senderGithubUserId: String
"""
Sender GitHub avatar URL.
"""
senderGithubAvatarUrl: String
"""
Requested reviewer GitHub login.
"""
requestedReviewerGithubLogin: String
"""
Requested reviewer GitHub user identifier.
"""
requestedReviewerGithubUserId: String
}
"""
Grouping modes supported by grouped Soup.
"""
enum GraphqlGroupByField {
"""
Group into date buckets.
"""
DATE
"""
Group by Soup entity type.
"""
ENTITY_TYPE
"""
Group by the Project property (initiative membership).
"""
PROJECT
"""
Group by a property value.
"""
PROPERTY
}
"""
GraphQL representation of a field used to group Soup items.
"""
input GraphqlGroupByInput {
"""
The kind of grouping to perform.
"""
field: GraphqlGroupByField!
"""
Property definition to group by when `field` is `PROPERTY`.
"""
propertyDefinitionId: ID
"""
Optional property entity type restriction.
"""
entityType: GraphqlPropertyEntityType
"""
Optional caller-defined date ranges; requires PROPERTY grouping.
"""
bucketing: GraphqlPropertyBucketing
}
"""
Metadata for an inbox that requires reauthentication.
"""
type GraphqlInboxReauthRequiredMetadata {
"""
Inbox email address.
"""
emailAddress: String!
}
"""
The two operands of a recursive `InitiativeFilterExpr` binary expression.
"""
input GraphqlInitiativeBinaryExpr {
"""
Left expression.
"""
left: GraphqlInitiativeExpr!
"""
Right expression.
"""
right: GraphqlInitiativeExpr!
}
"""
represents the initiative description subtype fields
"""
type GraphqlInitiativeDescriptionSubType {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
Metadata for a discussion in a project.
"""
type GraphqlInitiativeDiscussionMetadata {
"""
Project display name.
"""
projectName: String!
"""
Project owner principal.
"""
owner: String!
"""
Notification reason.
"""
reason: GraphqlInitiativeDiscussionReason!
"""
Shared message identifier.
"""
messageId: ID!
"""
Shared discussion root identifier.
"""
threadId: ID!
"""
Comment Markdown.
"""
text: String!
"""
Public bot display name, if applicable.
"""
senderDisplayName: String
"""
Sender avatar URL.
"""
senderProfilePictureUrl: String
}
"""
Why a project discussion notification was sent.
"""
enum GraphqlInitiativeDiscussionReason {
"""
Explicit user mention.
"""
MENTION
"""
Reply to a discussion.
"""
REPLY
"""
Comment on an assigned project.
"""
ASSIGNEE
"""
Comment on an owned project.
"""
OWNER
}
"""
A recursive `InitiativeFilterExpr` filter expression.
"""
input GraphqlInitiativeExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlInitiativeBinaryExpr
"""
Either expression may match.
"""
or: GraphqlInitiativeBinaryExpr
"""
Negate an expression.
"""
not: GraphqlInitiativeExpr
"""
Match a literal.
"""
literal: GraphqlInitiativeLiteral
}
"""
GraphQL input for selecting initiatives through Soup.
"""
input GraphqlInitiativeLiteral @oneOf {
"""
Opt into initiatives; must be true. Omit the filter to exclude them.
"""
include: Boolean
"""
Match an initiative identifier.
"""
id: ID
"""
Match the owning principal.
"""
owner: String
"""
Match a case-insensitive substring of the name.
"""
nameContains: String
"""
Match projects due before this RFC 3339 timestamp.
"""
dueBefore: String
"""
Match projects due after this RFC 3339 timestamp.
"""
dueAfter: String
"""
Exact notification state for the requester; also opts in.
"""
notificationState: NotificationState
}
"""
Metadata for a team invitation.
"""
type GraphqlInviteToTeamMetadata {
"""
Team name.
"""
teamName: String!
"""
Team identifier.
"""
teamId: ID!
"""
Team invitation identifier.
"""
teamInviteId: ID!
"""
Inviting user identifier.
"""
invitedBy: String!
"""
Invited role.
"""
role: String
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
A link property value.
"""
type GraphqlLinkPropertyValue {
"""
The stored URLs.
"""
urls: [String!]!
}
"""
Audience allowed to access an entity through its share link.
"""
enum GraphqlLinkShare {
"""
Anyone with the link can access the entity.
"""
PUBLIC
"""
Members of the owner's team with the link can access the entity.
"""
TEAM
}
"""
Body-free aggregate used to recompute view membership and previews.
"""
type GraphqlMailDraftAggregate {
"""
Count including trashed messages.
"""
messageCount: Int!
"""
Any message is inbox-visible.
"""
inboxVisible: Boolean!
"""
Every message is read.
"""
isRead: Boolean!
"""
Any eligible message is Signal.
"""
isSignal: Boolean!
"""
Any message has a calendar attachment.
"""
hasCalendarAttachment: Boolean!
"""
Inbound or Macro-draft recency.
"""
latestInboundMessageTs: String
"""
Non-spam or Macro-draft recency.
"""
latestNonSpamMessageTs: String
"""
Outbound recency.
"""
latestOutboundMessageTs: String
"""
Latest eligible preview.
"""
preview: GraphqlMailPreviewMessage
"""
Preview ordering timestamp.
"""
previewTs: String
}
"""
One draft's contribution, normalized by message identity.
"""
type GraphqlMailDraftEntry {
"""
Message identity.
"""
id: ID!
"""
Whether edits contribute their update time to Mail recency.
"""
macroDraft: Boolean!
"""
Aggregate contributed by this message.
"""
facts: GraphqlMailDraftAggregate!
}
"""
Metadata for applying and reversing offline draft edits across Mail views.
"""
type GraphqlMailDraftState {
"""
Complete non-draft contribution, independent of message pagination.
"""
baseline: GraphqlMailDraftAggregate!
"""
Independently replaceable draft contributions.
"""
drafts: [GraphqlMailDraftEntry!]!
}
"""
A body-free normalized message snapshot used by canonical Mail preview edges.
Its ID identifies the same message across ALL, Drafts and Sent references.
"""
type GraphqlMailPreviewMessage {
"""
Global message ID.
"""
id: ID!
"""
Message subject.
"""
subject: String
"""
Message snippet, never a body.
"""
snippet: String
"""
Whether this message is a draft.
"""
isDraft: Boolean!
"""
Sender email address.
"""
senderEmail: String
"""
Sender display name.
"""
senderName: String
"""
Sender photo URL.
"""
senderPhotoUrl: String
}
"""
Metadata for a mention in a document comment.
"""
type GraphqlMentionedInDocumentCommentMetadata {
"""
Document name.
"""
documentName: String!
"""
Document owner identifier.
"""
owner: String!
"""
Document file type.
"""
fileType: String
"""
Document subtype.
"""
subType: GraphqlNotificationDocumentSubType
"""
Mention identifier.
"""
mentionId: String!
"""
Comment identifier: a legacy numeric comment id, or the message id in
the shared message store.
"""
commentId: String!
"""
Comment thread identifier: a legacy numeric thread id, or the root
message id in the shared message store.
"""
threadId: String!
"""
Comment text.
"""
text: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
}
"""
User-safe failure for one requested entity mutation.
"""
type GraphqlMutationError {
"""
Stable machine-readable error category.
"""
errorCode: GraphqlEntityMutationErrorCode!
"""
User-safe explanation of the failure.
"""
message: String!
}
"""
Successful result for one requested entity mutation.
"""
type GraphqlMutationSuccess {
"""
Ordered normalized-cache effects produced by the mutation.
"""
effects: [SoupPatch!]!
}
"""
Metadata for a newly received email.
"""
type GraphqlNewEmailMetadata {
"""
Sender email address.
"""
sender: String
"""
Recipient email address.
"""
toEmail: String!
"""
Email thread identifier.
"""
threadId: String!
"""
Email subject.
"""
subject: String!
"""
Email snippet.
"""
snippet: String!
}
"""
A newly delivered notification patch.
"""
type GraphqlNewNotification {
"""
The newly delivered notification.
"""
notification: GraphqlNotification!
}
"""
Typed GraphQL union containing every supported notification event payload.
"""
union GraphqlNotifEvent = GraphqlExternalChatMessageMetadata | GraphqlEntityAccessGrantedMetadata | GraphqlEntityAccessRequestedMetadata | GraphqlChannelMentionMetadata | GraphqlDocumentMentionMetadata | GraphqlMentionedInDocumentCommentMetadata | GraphqlRepliedToDocumentCommentThreadMetadata | GraphqlCommentedOnDocumentMetadata | GraphqlInitiativeDiscussionMetadata | GraphqlCrmDiscussionMetadata | GraphqlChannelInviteMetadata | GraphqlChannelMessageSendMetadata | GraphqlChannelMessageReactionMetadata | GraphqlChannelReplyMetadata | GraphqlCallStartedMetadata | GraphqlNewEmailMetadata | GraphqlInboxReauthRequiredMetadata | GraphqlInviteToTeamMetadata | GraphqlTaskAssignedMetadata | GraphqlReminderMetadata | GraphqlCalendarEventReminderMetadata | GraphqlAiResponseMetadata | GraphqlGithubPrStatusChangedMetadata | GraphqlGithubPrCheckRunMetadata | GraphqlGithubReviewRequestedMetadata | GraphqlGithubPrCommentMetadata | GraphqlGithubPrMentionMetadata | GraphqlGithubPrReviewMetadata | GraphqlAgentSessionSettledMetadata | GraphqlAgentSessionWaitingForInputMetadata | GraphqlAgentSessionMentionedMetadata | GraphqlCalendarEventJoinRequestMetadata | GraphqlChannelAccessRequestedMetadata | GraphqlRoutineRunFinishedMetadata | GraphqlWhatsappGroupMessageMetadata
"""
A notification associated with a shared entity, including entities outside Soup.
"""
type GraphqlNotification {
"""
The notification identifier.
"""
id: ID!
"""
The event that produced the notification.
"""
eventType: String!
"""
The Soup type of the associated entity.
"""
entityType: GraphqlSoupEntityType! @deprecated(reason: "Use targetEntityType, which also covers entities outside Soup. Remove after 2026-12-01.")
"""
The type of the associated entity, including entities outside Soup.
"""
targetEntityType: GraphqlEntityType!
"""
The identifier of the associated entity.
"""
entityId: String!
"""
Whether the notification has been sent.
"""
sent: Boolean!
"""
The authoritative lifecycle state, independent of viewing timestamps.
"""
state: NotificationState!
"""
The notification creation time in RFC 3339 format.
"""
createdAt: String!
"""
The time the notification was viewed, in RFC 3339 format.
"""
viewedAt: String
"""
The notification's last update time in RFC 3339 format.
"""
updatedAt: String!
"""
The identifier of the user who triggered the notification.
"""
senderId: String
"""
Typed event-specific notification metadata.
"""
metadata: GraphqlNotifEvent!
}
"""
GraphQL channel type used by notification metadata.
"""
enum GraphqlNotificationChannelType {
"""
Public channel.
"""
PUBLIC
"""
Private channel.
"""
PRIVATE
"""
Direct-message channel.
"""
DIRECT_MESSAGE
"""
Team channel.
"""
TEAM
}
"""
GraphQL document subtype used by notification metadata.
"""
enum GraphqlNotificationDocumentSubType {
"""
Task document.
"""
TASK
"""
Snippet document.
"""
SNIPPET
"""
Skill document.
"""
SKILL
"""
The description document of an initiative.
"""
INITIATIVE_DESCRIPTION
}
"""
Filters applied before the per-entity notification limit.
"""
input GraphqlNotificationFilter {
"""
Exact states to include; omitted means active (unseen and seen).
An empty list matches no notifications.
"""
states: [NotificationState!]
"""
Event names to include; omitted or empty means every event type.
"""
eventTypes: [String!]
"""
Only notifications about top-level channel messages, including mentions but excluding reactions.
"""
topLevelMessagesOnly: Boolean
"""
Scope channel edges to their feed row rather than thread/mention stacks.
Scoping includes active seen reasons. Other entity edges are unchanged.
Applied before the edge limit.
"""
channelFeedOnly: Boolean
}
"""
Realtime notification patch represented as a new, updated, or deleted notification.
"""
union GraphqlNotificationPatch = GraphqlNewNotification | GraphqlUpdatedNotification | GraphqlCacheDeletion
"""
Number stored by a numeric select option.
"""
type GraphqlNumberPropertyOptionValue {
"""
Stored number.
"""
value: Float!
}
"""
A numeric property value.
"""
type GraphqlNumberPropertyValue {
"""
The stored number.
"""
value: Float!
}
"""
GraphQL representation of [`OwnerType`]: the kind of principal that owns an
entity. Paired with an `ownerId` principal string, which is a user id, a
bot id, or a team id depending on this discriminator.
"""
enum GraphqlOwnerType {
"""
A Macro user.
"""
USER
"""
A bot.
"""
BOT
"""
A team.
"""
TEAM
}
"""
The two operands of a recursive `ProjectFilterExpr` binary expression.
"""
input GraphqlProjectBinaryExpr {
"""
Left expression.
"""
left: GraphqlProjectExpr!
"""
Right expression.
"""
right: GraphqlProjectExpr!
}
"""
A recursive `ProjectFilterExpr` filter expression.
"""
input GraphqlProjectExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlProjectBinaryExpr
"""
Either expression may match.
"""
or: GraphqlProjectBinaryExpr
"""
Negate an expression.
"""
not: GraphqlProjectExpr
"""
Match a literal.
"""
literal: GraphqlProjectLiteral
}
"""
GraphQL input representing the project literal.
"""
input GraphqlProjectLiteral @oneOf {
"""
The project id option.
"""
projectId: ID
"""
The project id self option.
"""
projectIdSelf: ID
"""
The owner principal option — a user (`macro|<email>`), a bot
(`bot|<uuid>`), or a team (a bare hyphenated uuid).
"""
owner: String
"""
The importance option.
"""
importance: Boolean
"""
Exact notification state for the requester.
"""
notificationState: NotificationState
"""
The created at option.
"""
createdAt: GraphqlDateLiteral
"""
The updated at option.
"""
updatedAt: GraphqlDateLiteral
}
"""
A property assignment and its current value.
"""
type GraphqlProperty {
"""
The globally unique identifier of this entity-property assignment.
"""
id: ID!
"""
The identifier of the shared property definition.
"""
propertyDefinitionId: ID!
"""
The user-facing name of the property.
"""
displayName: String!
"""
The type of value accepted by the property.
"""
dataType: GraphqlPropertyDataType!
"""
Whether the property can contain more than one value.
"""
isMultiSelect: Boolean!
"""
The required entity type for entity-reference properties, when constrained.
"""
specificEntityType: GraphqlPropertyEntityType
"""
Whether this property is managed by the system.
"""
isSystem: Boolean!
"""
Whether this property describes entity metadata.
"""
isMetadata: Boolean!
"""
The current value, represented by exactly one typed union variant.
"""
value: GraphqlPropertyValue
}
"""
Transform the selected DATE property into caller-defined ranges.
Non-DATE values use the missing-value bucket.
"""
input GraphqlPropertyBucketing {
"""
Bucketing transformation.
"""
type: GraphqlPropertyBucketingType!
"""
Ordered, contiguous UTC ranges covering every present date.
"""
ranges: [GraphqlDateBucketRange!]!
"""
Key for entities whose selected property is absent or cleared.
"""
missingValueBucketKey: String!
}
"""
Supported property-value transformations.
"""
enum GraphqlPropertyBucketingType {
"""
Caller-defined half-open UTC date ranges.
"""
DATE_RANGES
}
"""
A property definition's supported value type.
"""
enum GraphqlPropertyDataType {
"""
Boolean true/false values.
"""
BOOLEAN
"""
Date and time values.
"""
DATE
"""
A span from a start date-time to an end one.
"""
DATE_RANGE
"""
Numeric values.
"""
NUMBER
"""
String or text values.
"""
STRING
"""
A select property with numeric options.
"""
SELECT_NUMBER
"""
A select property with string options.
"""
SELECT_STRING
"""
User- or team-scoped colored labels.
"""
TAG
"""
References to other entities.
"""
ENTITY
"""
URL values.
"""
LINK
}
"""
Explicit UTC bounds for a DATE property.
"""
input GraphqlPropertyDateRange {
"""
Inclusive UTC start, or no lower bound.
"""
start: String
"""
Exclusive UTC end, or no upper bound.
"""
end: String
}
"""
A globally identified property definition, independent of any assignment.
"""
type GraphqlPropertyDefinition {
"""
Global identity of the shared definition, not an entity assignment.
"""
id: ID!
"""
Principal owning the definition.
"""
owner: GraphqlPropertyDefinitionOwner!
"""
User-visible property name.
"""
displayName: String!
"""
The type of value accepted by this property.
"""
dataType: GraphqlPropertyDataType!
"""
Whether more than one selected value is supported.
"""
isMultiSelect: Boolean!
"""
Entity-reference type constraint, if any.
"""
specificEntityType: GraphqlPropertyEntityType
"""
Whether the system manages this definition.
"""
isSystem: Boolean!
"""
Whether the property represents generated entity metadata.
"""
isMetadata: Boolean!
"""
When this definition was created, as RFC 3339.
"""
createdAt: String!
"""
When this definition last changed, as RFC 3339.
"""
updatedAt: String!
"""
Selectable options, loaded only when requested.
"""
options: [GraphqlPropertyOption!]!
}
"""
Ownership facts embedded in a property definition.
"""
type GraphqlPropertyDefinitionOwner {
"""
Kind of owning principal.
"""
scope: GraphqlPropertyOwnerScope!
"""
User or team identifier; absent for system definitions.
"""
principalId: String
}
"""
Which authenticated-caller property definitions to list.
"""
enum GraphqlPropertyDefinitionScope {
"""
Definitions owned by the viewer.
"""
USER
"""
Definitions owned by the viewer's team.
"""
TEAM
"""
System definitions shared by all viewers.
"""
SYSTEM
"""
The viewer's personal, team, and system definitions.
"""
ALL
}
"""
An entity reference stored in a property value.
"""
type GraphqlPropertyEntityReference {
"""
The referenced entity's identifier.
"""
entityId: String!
"""
The referenced entity's property-domain type.
"""
entityType: GraphqlPropertyEntityType!
"""
The specific message identifier when the reference targets a thread message.
"""
specificMessageId: ID
}
"""
An entity type supported by the properties domain.
"""
enum GraphqlPropertyEntityType {
"""
Calendar event entity.
"""
CALENDAR_EVENT
"""
Call record entity.
"""
CALL_RECORD
"""
Channel entity.
"""
CHANNEL
"""
Chat entity.
"""
CHAT
"""
Company entity.
"""
COMPANY
"""
Database row entity.
"""
DATABASE_ROW
"""
CRM contact entity.
"""
CONTACT
"""
Document entity.
"""
DOCUMENT
"""
Initiative entity.
"""
INITIATIVE
"""
Project entity.
"""
PROJECT
"""
Task entity.
"""
TASK
"""
Thread entity.
"""
THREAD
"""
User entity.
"""
USER
}
"""
A globally identified selectable option belonging to one property definition.
"""
type GraphqlPropertyOption {
"""
Stable global identity of this selectable option.
"""
id: ID!
"""
Definition to which the option belongs.
"""
propertyDefinitionId: ID!
"""
Ordering within the definition's available options.
"""
displayOrder: Int!
"""
Typed option value.
"""
value: GraphqlPropertyOptionValue!
"""
Optional display color.
"""
color: String
"""
Creation time as RFC 3339.
"""
createdAt: String!
"""
Last update time as RFC 3339.
"""
updatedAt: String!
}
"""
Exactly one of the supported option value types.
"""
union GraphqlPropertyOptionValue = GraphqlStringPropertyOptionValue | GraphqlNumberPropertyOptionValue
"""
The kind of principal owning a property definition.
"""
enum GraphqlPropertyOwnerScope {
"""
A personal definition.
"""
USER
"""
A team definition.
"""
TEAM
"""
A system definition.
"""
SYSTEM
"""
A column of one database.
"""
DATABASE
}
"""
Canonical entity type accepted for property targets.
"""
enum GraphqlPropertyTargetEntityType {
"""
Call record target.
"""
CALL_RECORD
"""
Channel target.
"""
CHANNEL
"""
Chat target.
"""
CHAT
"""
CRM company target.
"""
COMPANY
"""
Row of a Macro database table.
"""
DATABASE_ROW
"""
Document target, including tasks and snippets.
"""
DOCUMENT
"""
Initiative target, displayed as a Project in the application.
"""
INITIATIVE
"""
Folder project target.
"""
PROJECT
"""
Email thread target.
"""
THREAD
"""
User target.
"""
USER
}
"""
A property value represented by a type-safe GraphQL union.
"""
union GraphqlPropertyValue = GraphqlBooleanPropertyValue | GraphqlNumberPropertyValue | GraphqlStringPropertyValue | GraphqlDatePropertyValue | GraphqlDateRangePropertyValue | GraphqlSelectOptionPropertyValue | GraphqlEntityReferencePropertyValue | GraphqlLinkPropertyValue
"""
An agent session an account registered as its work.
"""
type GraphqlRegisteredWork {
"""
The registration.
"""
id: ID!
"""
The account whose work this is.
"""
accountId: ID!
"""
When the account registered it, in RFC 3339.
"""
registeredAt: String!
"""
The session registered.
"""
session: GraphqlSoupAgentSession!
}
"""
Changes may have been missed or sharing changed: refetch the list.
"""
type GraphqlRegisteredWorkInvalidate {
"""
Always true.
"""
refresh: Boolean!
}
"""
One change to the registered work of the subscribed accounts.
"""
union GraphqlRegisteredWorkPatch = GraphqlRegisteredWorkUpsert | GraphqlRegisteredWorkRemove | GraphqlRegisteredWorkInvalidate
"""
A registration that ended or whose session was archived.
"""
type GraphqlRegisteredWorkRemove {
"""
The registration to stop showing.
"""
id: ID!
}
"""
A registration to show, new or with its session's list fields changed.
"""
type GraphqlRegisteredWorkUpsert {
"""
The registration.
"""
entry: GraphqlRegisteredWork!
}
"""
The two operands of a recursive reminder filter expression. Ignored.
Remove after 2026-11-30.
"""
input GraphqlReminderBinaryExpr {
"""
Left expression.
"""
left: GraphqlReminderExpr!
"""
Right expression.
"""
right: GraphqlReminderExpr!
}
"""
A recursive reminder filter expression. Ignored. Remove after 2026-11-30.
"""
input GraphqlReminderExpr @oneOf {
"""
Both expressions must match.
"""
and: GraphqlReminderBinaryExpr
"""
Either expression may match.
"""
or: GraphqlReminderBinaryExpr
"""
Negate an expression.
"""
not: GraphqlReminderExpr
"""
Match a literal.
"""
literal: GraphqlReminderLiteral
}
"""
A reminder literal. Ignored. Remove after 2026-11-30.
"""
input GraphqlReminderLiteral @oneOf {
"""
Opt the query into reminders.
"""
include: Boolean
"""
The reminder id.
"""
id: ID
"""
The referenced entity, as `"{type}:{id}"`.
"""
entity: String
"""
Whether the owner marked the reminder done.
"""
completed: Boolean
"""
Whether the reminder came due.
"""
fired: Boolean
}
"""
Metadata for a due reminder.
"""
type GraphqlReminderMetadata {
"""
Reminder identifier.
"""
reminderId: ID!
"""
Reminder description.
"""
description: String!
"""
Which firing this notification is for, in RFC 3339 format.
The counterpart of a calendar alarm's `occurrenceKey`: it is what tells
two notifications from the same recurring reminder apart. Absent on
notifications written before recurring dispatch existed.
"""
scheduledFor: String
}
"""
How often a reminder fires. Never returned. Remove after 2026-11-30.
"""
enum GraphqlReminderScheduleType {
"""
Fires once, at `remindAt`.
"""
ONCE
"""
Fires repeatedly, on `cron` evaluated in `timezone`.
"""
RECURRING
}
"""
Metadata for a reply to a document comment thread.
"""
type GraphqlRepliedToDocumentCommentThreadMetadata {
"""
Document name.
"""
documentName: String!
"""
Document owner identifier.
"""
owner: String!
"""
Document file type.
"""
fileType: String
"""
Document subtype.
"""
subType: GraphqlNotificationDocumentSubType
"""
Comment identifier: a legacy numeric comment id, or the message id in
the shared message store.
"""
commentId: String!
"""
Comment thread identifier: a legacy numeric thread id, or the root
message id in the shared message store.
"""
threadId: String!
"""
Reply text.
"""
text: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
"""
Display name for a non-user sender.
"""
senderDisplayName: String
}
"""
Metadata for a finished routine run.
"""
type GraphqlRoutineRunFinishedMetadata {
"""
Routine id.
"""
routineId: ID!
"""
Routine name when it ran.
"""
routineName: String!
"""
Whether the run succeeded.
"""
succeeded: Boolean!
}
"""
A saved filter definition, not a snapshot of matching entities.
"""
type GraphqlSavedView {
"""
Stable identity of this saved definition.
"""
id: ID!
"""
User who owns and can edit this definition.
"""
ownerId: ID!
"""
Display name chosen by the owner.
"""
name: String!
"""
Versioned filter configuration interpreted by the consuming feature.
"""
config: JSON!
"""
Team with effective access, or null when the definition is private.
"""
sharedTeamId: ID
"""
Current revision required for conditional updates and deletion.
"""
revision: Int!
"""
Creation timestamp in RFC 3339 format.
"""
createdAt: String!
"""
Last update timestamp in RFC 3339 format.
"""
updatedAt: String!
}
"""
A page ordered by creation time and ID after effective visibility checks.
"""
type GraphqlSavedViewPage {
"""
Definitions the authenticated viewer can currently access.
"""
nodes: [GraphqlSavedView!]!
"""
Opaque continuation cursor, or null when the listing is complete.
"""
nextCursor: String
}
"""
An AI routine the authenticated user can access.
"""
type GraphqlScheduledAction {
"""
Stable identifier of the routine.
"""
id: ID!
"""
Name shown for the routine.
"""
name: String!
"""
Whether automatic dispatch runs this routine.
"""
enabled: Boolean!
"""
What starts a run of this routine.
"""
trigger: GraphqlScheduledActionTrigger!
"""
The agent step this routine hands off to: its only one, or the first of
several in different branches. Null when no step runs an agent.
"""
agentTask: GraphqlScheduledActionAgentTask
"""
When the current execution claim stops blocking configuration changes.
The timestamp stays present after that instant so clients can compare it themselves.
"""
claimExpiresAt: String
"""
When the routine was created, as RFC 3339.
"""
createdAt: String!
"""
When the routine row last changed, including execution bookkeeping, as RFC 3339.
"""
updatedAt: String!
}
"""
An agent selected to run a routine.
"""
type GraphqlScheduledActionAgent {
"""
Stable identifier of the selected agent.
"""
botId: ID!
}
"""
The agent task a routine runs.
"""
type GraphqlScheduledActionAgentTask {
"""
Model the task runs. Null when the selected agent uses its default model.
"""
model: String
"""
Selected agent. Null for model-only tasks.
"""
agent: GraphqlScheduledActionAgent
"""
Always empty: the agent step's instructions are in `userPrompt`.
"""
prompt: String!
"""
The agent step's instructions.
"""
userPrompt: String!
}
"""
A routine that runs on a cron schedule.
"""
type GraphqlScheduledActionCronTrigger {
"""
Cron expression in the six- or seven-field format the scheduler accepts.
"""
schedule: String!
"""
Time zone name the cron expression is evaluated in.
"""
timezone: String!
"""
Next cron firing, as RFC 3339. Null when the routine is disabled.
"""
nextRunAt: String
}
"""
One event filter. The event name and entity id must both match.
"""
type GraphqlScheduledActionEventFilter {
"""
Event names that can satisfy this filter.
"""
events: [GraphqlScheduledActionEventName!]!
"""
Entity ids that can satisfy this filter. Null matches every id; an empty list matches nothing.
"""
entityIds: [ID!]
"""
Which GitHub App deliveries satisfy a `GITHUB` filter.
"""
github: GraphqlScheduledActionGithubSelector
"""
Exact payload tests a GitHub delivery must pass, as a reader would state them.
"""
payloadMatch: [String!]!
"""
The task property that must have changed, and the values it must gain.
"""
property: GraphqlScheduledActionPropertySelector
"""
Yes/no question the triggering content must answer with yes before the routine runs.
"""
condition: String
}
"""
Events a routine filter can name.
"""
enum GraphqlScheduledActionEventName {
"""
A document was created.
"""
DOCUMENT_CREATED
"""
A document was updated.
"""
DOCUMENT_UPDATED
"""
A document was deleted.
"""
DOCUMENT_DELETED
"""
A task was created.
"""
TASK_CREATED
"""
A task's status changed.
"""
TASK_STATUS_CHANGED
"""
A task's priority changed.
"""
TASK_PRIORITY_CHANGED
"""
A task property changed.
"""
TASK_PROPERTY_CHANGED
"""
A new email was received.
"""
EMAIL_MESSAGE_RECEIVED
"""
A channel was created.
"""
CHANNEL_CREATED
"""
A channel message was posted.
"""
CHANNEL_MESSAGE_POSTED
"""
A user was mentioned in a channel.
"""
CHANNEL_MENTIONED
"""
A channel message was patched.
"""
CHANNEL_MESSAGE_PATCHED
"""
A channel message attachment was created.
"""
CHANNEL_MESSAGE_ATTACHMENT_CREATED
"""
A call the routine's owner started began.
"""
CALL_STARTED
"""
A call the routine's owner joined ended.
"""
CALL_ENDED
"""
Macro's GitHub App received a delivery.
"""
GITHUB
}
"""
A routine that runs when matching events are published.
"""
type GraphqlScheduledActionEventsTrigger {
"""
Event filters. A run starts when any filter matches.
"""
filters: [GraphqlScheduledActionEventFilter!]!
}
"""
GitHub deliveries a filter watches. Empty lists match everything.
"""
type GraphqlScheduledActionGithubSelector {
"""
GitHub event names, such as `workflow_run`.
"""
events: [String!]!
"""
Payload actions, such as `completed`.
"""
actions: [String!]!
"""
Repositories, as `owner/name`.
"""
repositories: [String!]!
"""
Whether deliveries caused by bots also match.
"""
includeBots: Boolean!
}
"""
Any of several schedules and optional Macro event filters.
"""
type GraphqlScheduledActionMultipleTrigger {
"""
Each schedule retains its own timezone and next firing.
"""
schedules: [GraphqlScheduledActionCronTrigger!]!
"""
Single runs at exact times.
"""
once: [GraphqlScheduledActionOnceTrigger!]!
"""
Events that can also trigger this routine.
"""
events: GraphqlScheduledActionEventsTrigger
}
"""
A routine that runs a single time.
"""
type GraphqlScheduledActionOnceTrigger {
"""
When the routine runs, as RFC 3339.
"""
at: String!
"""
Whether that run is still ahead. False once it has run.
"""
pending: Boolean!
}
"""
A task property a filter watches.
"""
type GraphqlScheduledActionPropertySelector {
"""
The property definition that must have changed.
"""
definitionId: ID!
"""
Select option or referenced entity ids, one of which the change must add. Empty matches any change.
"""
values: [String!]!
}
"""
The way a routine starts.
"""
union GraphqlScheduledActionTrigger = GraphqlScheduledActionCronTrigger | GraphqlScheduledActionEventsTrigger | GraphqlScheduledActionOnceTrigger | GraphqlScheduledActionMultipleTrigger
"""
The persisted state of a scheduled delivery.
"""
enum GraphqlScheduledSendStatus {
"""
Waiting for its send time or safely retrying preparation.
"""
PENDING
"""
Provider submission has started.
"""
SENDING
"""
Delivery was definitely rejected; the draft can be restored.
"""
FAILED
"""
Delivery may have succeeded; reconciliation is required.
"""
UNCONFIRMED
}
"""
A select-option property value.
"""
type GraphqlSelectOptionPropertyValue {
"""
The selected option identifiers.
"""
optionIds: [ID!]!
}
"""
Bot fields presented through an agent-session edge.
"""
type GraphqlSessionBot {
"""
Stable global bot identity.
"""
id: ID!
"""
Bot display name.
"""
name: String!
"""
Optional bot avatar URL.
"""
avatarUrl: String
}
"""
A typed value accepted when setting an entity property.
"""
input GraphqlSetPropertyValue @oneOf {
"""
A Boolean value.
"""
boolean: Boolean
"""
An RFC 3339 date-time value.
"""
date: String
"""
A span from a start date-time to an end one.
"""
dateRange: GraphqlDateRangeInput
"""
A numeric value.
"""
number: Float
"""
A string value.
"""
string: String
"""
A single selected option identifier.
"""
selectOption: ID
"""
Multiple selected option identifiers.
"""
multiSelectOption: [ID!]
"""
A single entity reference.
"""
entityReference: GraphqlEntityReferenceInput
"""
Multiple entity references.
"""
multiEntityReference: [GraphqlEntityReferenceInput!]
"""
A single URL value.
"""
link: String
"""
Multiple URL values.
"""
multiLink: [String!]
}
"""
Operation applied to one channel share-policy entry.
"""
enum GraphqlSharePolicyOperation {
"""
Add an entry.
"""
ADD
"""
Remove an entry.
"""
REMOVE
"""
Replace an existing entry.
"""
REPLACE
}
"""
GraphQL input representing the shared email filter.
"""
enum GraphqlSharedEmailFilter {
"""
The exclude option.
"""
EXCLUDE
"""
The include option.
"""
INCLUDE
"""
The only option.
"""
ONLY
}
"""
GraphQL representation of Soup timestamp, notification, and selected-property sorts.
"""
enum GraphqlSimpleSortMethod {
"""
Sort by most recently viewed.
"""
VIEWED_AT
"""
Sort by creation timestamp.
"""
CREATED_AT
"""
Sort by update timestamp.
"""
UPDATED_AT
"""
Sort by viewed timestamp, falling back to updated timestamp.
"""
VIEWED_UPDATED
"""
Only entities the caller holds a live notification for, most recently
notified first. Descending `soup` only; not supported by `groupSoup`.
"""
NOTIFIED_AT
"""
Sort by the selected property key, missing last, then newest update and ID.
Missing definitions and unsupported types use update-time ordering.
Email, channels, calls, companies, and agent sessions never appear.
"""
PROPERTY
}
"""
represents the skill subtype fields
"""
type GraphqlSkillSubType {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
represents the snippet subtype fields
"""
type GraphqlSnippetSubType {
"""
this object has nothing as a field but we need at least 1 field
"""
nothing: Boolean!
}
"""
Direction a Soup page is ordered in.
"""
enum GraphqlSortDirection {
"""
Oldest, or soonest-firing, first.
"""
ASC
"""
Newest first.
"""
DESC
}
"""
GraphQL representation of the soup agent session.
"""
type GraphqlSoupAgentSession implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Server-only projection facts are unavailable for agent sessions.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common agent session metadata.
`parent` is absent: a session is reachable through the channel thread
it was opened from, but it is not contained by it the way a chat is
contained by its project.
"""
metadata: GraphqlEntityMetadata!
"""
The name.
"""
name: String!
"""
Whether the session is archived and read-only.
"""
isArchived: Boolean! @deprecated(reason: "Use archivedBy. Remove after 2026-12-03.")
"""
Who or what archived the session, or null while it is active. An archived session is
read-only.
"""
archivedBy: GraphqlAgentSessionArchiveCause
"""
When the session was archived, or null while it is active.
"""
archivedAt: String
"""
The principal identifier of the owner.
"""
ownerId: String!
"""
The kind of principal `ownerId` names.
"""
ownerType: GraphqlOwnerType!
"""
The bot running this session.
"""
botId: ID!
"""
The bot running this session, when its profile still exists.
"""
bot: GraphqlSessionBot
"""
The session's raw protocol log: what the client folds into messages.
Served whole, in log order, the same rows the harness's REST log
endpoint serves.
"""
log: GraphqlAgentSessionLog!
"""
The runtime snapshotted when the session was created.
"""
harness: String!
"""
The repository the session works with, when one was selected.
"""
repoUrl: String
"""
The starting branch selected for this session, not its current branch.
"""
repoBranch: String
"""
The persisted pull request associated with the session.
"""
pullRequestUrl: String
"""
Last captured working branch, when the runtime has reported one.
"""
workingBranch: String
"""
Last synchronized state of the linked pull request, when visible.
"""
pullRequestState: GraphqlAgentPullRequestState
"""
The linked pull request's Macro entity, when visible to the viewer.
"""
pullRequestId: ID
"""
Last persisted fold turn state. Absent until an older session next runs.
"""
turnState: String
"""
The channel thread the session was opened from, when any.
"""
threadId: ID
"""
Who started the session.
"""
source: GraphqlAgentSessionSource!
"""
Where the session is shown.
"""
visibility: GraphqlAgentSessionVisibility!
"""
The session's last known status: `no_messages`, `disconnected`, or the
wire name of the most recent system event (for example `session/end`).
"""
status: String!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of a Soup group bin.
"""
type GraphqlSoupBin {
"""
The grouping key.
"""
key: String!
"""
Display text for a group whose key alone does not identify it client
side, limited to what the viewer can read. Null when the client labels
the key itself or the viewer cannot read the entity behind it.
"""
label: String
"""
Total number of items in this group across all pages.
"""
totalCount: Int!
"""
Stored option order or calendar bucket order, when available.
"""
displayOrder: Int
"""
Opaque cursor for the next page in this bin, if one exists.
"""
nextCursor: String
"""
Items in this bin, ordered by their index within the group.
"""
items: [GraphqlSoupEntity!]!
}
"""
GraphQL representation of a canonical calendar event.
"""
type GraphqlSoupCalendarEvent implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common calendar event metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The owning Macro user.
"""
ownerId: String!
"""
The event title.
"""
title: String!
"""
The event description.
"""
description: String
"""
The event location.
"""
location: String
"""
Canonical event status.
"""
status: String!
"""
Timed or all-day event span.
"""
time: JSON!
"""
Direct conference join URL.
"""
conferenceUrl: String
"""
Which conferencing system backs the join URL.
"""
conferenceProvider: String
"""
Whether the canonical source is read-only.
"""
isReadOnly: Boolean!
"""
Creation timestamp.
"""
createdAt: String!
"""
Update timestamp.
"""
updatedAt: String!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
}
"""
GraphQL representation of the soup call.
"""
type GraphqlSoupCall implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
User-visible call name.
"""
displayName: String
"""
Common call metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The identifier of the channel.
"""
channelId: ID
"""
The channel name.
"""
channelName: String
"""
The user who created the call.
"""
createdBy: String!
"""
The custom name.
"""
customName: String
"""
The name.
"""
name: String
"""
The summary.
"""
summary: String
"""
The started timestamp in RFC 3339 format.
"""
startedAt: String!
"""
The ended timestamp in RFC 3339 format.
"""
endedAt: String
"""
The duration ms.
"""
durationMs: Int
"""
Whether the call is currently active.
"""
isActive: Boolean!
"""
The status.
"""
status: String!
"""
Whether the requesting user attended this call.
"""
attended: Boolean!
"""
The participant count.
"""
participantCount: Int!
"""
The identifiers of the participants.
"""
participantIds: [String!]!
"""
The participants.
"""
participants: [GraphqlSoupCallParticipant!]!
"""
Non-account guests who attended the call.
"""
guests: [GraphqlSoupCallGuest!]!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of a non-account call guest.
"""
type GraphqlSoupCallGuest {
"""
Opaque guest identity; matches the guest's transcript speaker id.
"""
id: ID!
"""
Guest-provided display name.
"""
displayName: String!
"""
The joined timestamp in RFC 3339 format.
"""
joinedAt: String!
"""
The left timestamp in RFC 3339 format.
"""
leftAt: String
}
"""
GraphQL representation of the soup call participant.
"""
type GraphqlSoupCallParticipant {
"""
The identifier of the user.
"""
userId: String!
"""
The joined timestamp in RFC 3339 format.
"""
joinedAt: String!
"""
The left timestamp in RFC 3339 format.
"""
leftAt: String
}
"""
GraphQL representation of the soup channel.
"""
type GraphqlSoupChannel implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common channel metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The name.
"""
name: String
"""
The channel type.
"""
channelType: String!
"""
The identifier of the owner.
"""
ownerId: String!
"""
The identifier of the organization.
"""
organizationId: ID
"""
The identifier of the team.
"""
teamId: ID
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
The interacted timestamp in RFC 3339 format.
"""
interactedAt: String
"""
Whether the requesting user is an active participant of the channel.
"""
isParticipant: Boolean!
"""
The participant count.
"""
participantCount: Int!
"""
The identifiers of the participants.
"""
participantIds: [String!]!
"""
The participants.
"""
participants: [GraphqlSoupChannelParticipant!]!
"""
The latest message.
"""
latestMessage: GraphqlSoupChannelMessagePreview
"""
The latest non thread message.
"""
latestNonThreadMessage: GraphqlSoupChannelMessagePreview
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of the soup channel thread.
"""
type GraphqlSoupChannelMessage implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
Channel messages do not have a separate display name.
"""
displayName: String
"""
The message content.
"""
content: String!
"""
Common channel-message metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The identifier of the channel.
"""
channelId: ID!
"""
The identifier of the sender.
"""
senderId: String!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The effective updated timestamp in RFC 3339 format.
"""
effectiveUpdatedAt: String!
"""
The reply count.
"""
replyCount: Int!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of the soup channel message.
"""
type GraphqlSoupChannelMessagePreview {
"""
The projected message identifier.
"""
messageId: ID!
"""
The parent channel identifier.
"""
channelId: ID!
"""
The identifier of the thread.
"""
threadId: ID
"""
The identifier of the sender.
"""
senderId: String!
"""
The content.
"""
content: String!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The deleted timestamp in RFC 3339 format.
"""
deletedAt: String
"""
The mentions.
"""
mentions: [String!]!
}
"""
GraphQL representation of the soup channel participant.
"""
type GraphqlSoupChannelParticipant {
"""
The identifier of the channel.
"""
channelId: ID!
"""
The identifier of the user.
"""
userId: String!
"""
The role.
"""
role: String!
"""
The joined timestamp in RFC 3339 format.
"""
joinedAt: String!
"""
The left timestamp in RFC 3339 format.
"""
leftAt: String
}
"""
GraphQL representation of the soup chat.
"""
type GraphqlSoupChat implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Server-only projection facts are unavailable for chats.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common chat metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The name.
"""
name: String!
"""
The last model selected for a sent message (`provider/model` id).
"""
model: String
"""
The principal identifier of the owner.
"""
ownerId: String!
"""
The kind of principal `ownerId` names.
"""
ownerType: GraphqlOwnerType!
"""
The identifier of the project.
"""
projectId: ID
"""
Whether the chat is persistent.
"""
isPersistent: Boolean!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
The deleted timestamp in RFC 3339 format.
"""
deletedAt: String
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of the soup crm company.
"""
type GraphqlSoupCrmCompany implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
User-visible company name.
"""
displayName: String
"""
Common CRM-company metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The identifier of the team.
"""
teamId: ID!
"""
The name.
"""
name: String
"""
The description.
"""
description: String
"""
Whether email sync is enabled for this company.
"""
emailSync: Boolean!
"""
Whether the company is hidden from CRM listings.
"""
hidden: Boolean!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
The domains.
"""
domains: [String!]!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
Rows of the viewer's live pipelines that reference this record, grouped
by pipeline in each one's row order.
"""
pipelineEntries: [GraphqlCrmPipelineEntry!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
A team-owned CRM contact with its original record identity and shared Soup edges.
"""
type GraphqlSoupCrmContact implements GraphqlSoupEntity {
"""
Original CRM contact ID.
"""
id: ID!
"""
Canonical contact kind.
"""
entityType: GraphqlSoupEntityType!
"""
Contacts do not use document cache projections.
"""
cacheProjection: SoupCacheProjection
"""
Team-local name, falling back to the email address.
"""
displayName: String
"""
Record metadata; the parent is the owning company.
"""
metadata: GraphqlEntityMetadata!
"""
Owning team.
"""
teamId: ID!
"""
Parent company; null for a contact without a company.
"""
parentCompanyId: ID
"""
Parent company's display name; null without a company.
"""
parentCompanyName: String
"""
Full email address; null for a contact added by name alone.
"""
emailAddress: String
"""
Parent company, or the nil ID for a contact without a company.
"""
companyId: ID! @deprecated(reason: "Use parentCompanyId. Remove after 2026-12-10.")
"""
Parent company's display name, or empty without a company.
"""
companyName: String! @deprecated(reason: "Use parentCompanyName. Remove after 2026-12-10.")
"""
Full email address, or empty for a contact added by name alone.
"""
email: String! @deprecated(reason: "Use emailAddress. Remove after 2026-12-10.")
"""
Team-local display name.
"""
name: String
"""
Effective hidden state of the contact and its company.
"""
hidden: Boolean!
"""
Earliest interaction with this contact on its owning team.
"""
firstInteraction: String!
"""
Most recent interaction with this contact on its owning team.
"""
lastInteraction: String!
"""
Record creation timestamp.
"""
createdAt: String!
"""
Record update timestamp.
"""
updatedAt: String!
"""
Viewer visit timestamp.
"""
viewedAt: String
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
Rows of the viewer's live pipelines that reference this record, grouped
by pipeline in each one's row order.
"""
pipelineEntries: [GraphqlCrmPipelineEntry!]!
"""
Optional viewer frecency score.
"""
frecencyScore: Float
}
"""
A row of a Macro database table. Its cells are its `properties`, keyed
by the columns' property definitions.
"""
type GraphqlSoupDatabaseRow implements GraphqlSoupEntity {
"""
The row identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Server-only projection facts are unavailable for rows.
"""
cacheProjection: SoupCacheProjection
"""
Rows have no name of their own.
"""
displayName: String
"""
Common row metadata; the owner is the database's.
"""
metadata: GraphqlEntityMetadata!
"""
The table the row belongs to.
"""
tableId: ID!
"""
The database the table belongs to.
"""
databaseId: ID!
"""
Fractional index ordering the row within its table.
"""
position: String!
"""
The principal identifier of the owner: the database's owner.
"""
ownerId: String!
"""
Who created the row, when they still exist. Named apart from other
entities' non-null `createdBy` so one selection can hold both.
"""
creatorId: String
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of the soup document.
"""
type GraphqlSoupDocument implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque authoritative server-only projection facts.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common document metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The name.
"""
name: String!
"""
The principal identifier of the owner.
"""
ownerId: String!
"""
The kind of principal `ownerId` names.
"""
ownerType: GraphqlOwnerType!
"""
The file type.
"""
fileType: String
"""
The identifier of the project.
"""
projectId: ID
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
The deleted timestamp in RFC 3339 format.
"""
deletedAt: String
"""
The sub type.
"""
subType: GraphqlSoupDocumentSubType
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of the soup document sub type.
"""
union GraphqlSoupDocumentSubType = GraphqlTaskSubType | GraphqlSnippetSubType | GraphqlSkillSubType | GraphqlInitiativeDescriptionSubType
"""
GraphQL representation of the soup email attachment.
"""
type GraphqlSoupEmailAttachment {
"""
The unique identifier.
"""
id: ID!
"""
The identifier of the message.
"""
messageId: ID!
"""
The identifier of the provider attachment.
"""
providerAttachmentId: String
"""
The filename.
"""
filename: String
"""
The mime type.
"""
mimeType: String
"""
The size bytes.
"""
sizeBytes: Int
"""
The identifier of the content.
"""
contentId: String
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
}
"""
An email sender or recipient embedded in a message.
"""
type GraphqlSoupEmailContact {
"""
The contact's email address.
"""
email: String!
"""
The contact's display name.
"""
name: String
"""
The contact's profile photo URL.
"""
photoUrl: String
}
"""
An uploaded attachment embedded in a draft email message.
"""
type GraphqlSoupEmailDraftAttachment {
"""
The attachment's canonical identifier.
"""
id: ID!
"""
The draft message identifier.
"""
draftId: ID!
"""
The original filename.
"""
fileName: String!
"""
The MIME type.
"""
contentType: String!
"""
The SHA-256 content digest.
"""
sha: String!
"""
The attachment size in bytes.
"""
size: Int!
"""
The storage key containing the uploaded attachment.
"""
s3Key: String!
"""
True until upload completion is verified.
"""
uploadPending: Boolean!
"""
Original inline attachment identity.
"""
contentId: String
"""
Whether the attachment belongs in the message body.
"""
isInline: Boolean!
}
"""
A forwarded provider attachment embedded in a draft email message.
"""
type GraphqlSoupEmailForwardedAttachment {
"""
The original attachment identifier.
"""
attachmentId: ID!
"""
The draft message identifier.
"""
draftId: ID!
"""
The attachment identifier assigned by the email provider.
"""
providerAttachmentId: String
"""
The provider identifier of the original message.
"""
messageProviderId: String!
"""
The original filename.
"""
filename: String
"""
The MIME type.
"""
mimeType: String
"""
The attachment size in bytes.
"""
sizeBytes: Int
}
"""
Canonical normalized GraphQL email label used by both email threads and
the authenticated user's label catalog.
"""
type GraphqlSoupEmailLabel {
"""
Stable database identifier for the label.
"""
id: ID!
"""
Identifier of the email link that owns the label.
"""
linkId: ID!
"""
Provider-specific label identifier.
"""
providerLabelId: String!
"""
User-visible label name.
"""
name: String!
"""
Label creation timestamp in RFC 3339 format.
"""
createdAt: String!
"""
Provider message-list visibility value.
"""
messageListVisibility: String!
"""
Provider label-list visibility value.
"""
labelListVisibility: String!
"""
Whether the label is provider-created or user-created.
"""
type: String!
}
"""
An adaptively hydrated email content projection for Soup queries.
"""
type GraphqlSoupEmailMessage {
"""
Generation required when editing a draft after send/cancellation.
"""
draftGeneration: Int!
"""
Immutable scheduling snapshots; JSON keeps both transports identical.
"""
calendarInvitations: JSON!
"""
The unique message identifier.
"""
id: ID!
"""
Provider-neutral synchronization and delivery progress, including uncertainty.
"""
operationStatus: EmailMessageOperation
"""
The identifier assigned by the email provider.
"""
providerId: String
"""
The identifier of the containing thread.
"""
threadId: ID!
"""
The identifier of the message this message replies to.
"""
replyingToId: ID
"""
The identifier of the linked email account.
"""
linkId: ID!
"""
The message subject.
"""
subject: String
"""
A short preview of the message content.
"""
snippet: String
"""
The provider's internal timestamp in RFC 3339 format.
"""
internalDateTs: String
"""
The sent timestamp in RFC 3339 format.
"""
sentAt: String
"""
Whether the message has been read.
"""
isRead: Boolean!
"""
Whether the message is starred.
"""
isStarred: Boolean!
"""
Whether the message was sent by the linked account.
"""
isSent: Boolean!
"""
Whether the message is a draft.
"""
isDraft: Boolean!
"""
Whether the message has attachments.
"""
hasAttachments: Boolean!
"""
When this draft is scheduled to be sent, in RFC 3339 format.
"""
scheduledSendTime: String
"""
Whether the scheduled delivery is pending, sending, failed, or unconfirmed.
"""
scheduledSendStatus: GraphqlScheduledSendStatus
"""
The sender of the message.
"""
from: GraphqlSoupEmailContact
"""
The primary recipients of the message.
"""
to: [GraphqlSoupEmailContact!]!
"""
The carbon-copy recipients of the message.
"""
cc: [GraphqlSoupEmailContact!]!
"""
The blind-carbon-copy recipients of the message.
"""
bcc: [GraphqlSoupEmailContact!]!
"""
Labels assigned to the message.
"""
labels: [GraphqlSoupEmailMessageLabel!]!
"""
The parsed message body.
"""
bodyParsed: String
"""
The plain-text message body.
"""
bodyText: String
"""
The sanitized HTML message body.
"""
bodyHtmlSanitized: String
"""
The message body in Macro's rich-text format.
"""
bodyMacro: String
"""
The message body with quoted replies removed.
"""
bodyReplyless: String
"""
Provider-hosted attachments on the message.
"""
attachments: [GraphqlSoupEmailMessageAttachment!]!
"""
Uploaded attachments belonging to a draft message.
"""
attachmentsDraft: [GraphqlSoupEmailDraftAttachment!]!
"""
Forwarded provider attachments belonging to a draft message.
"""
attachmentsForwarded: [GraphqlSoupEmailForwardedAttachment!]!
"""
The creation timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The last-updated timestamp in RFC 3339 format.
"""
updatedAt: String!
}
"""
A provider-hosted attachment embedded in an email message.
"""
type GraphqlSoupEmailMessageAttachment {
"""
Cloud-reference attachments open in the provider and have no binary download.
"""
referenceUrl: String
"""
The attachment's canonical database identifier.
"""
id: ID!
"""
The attachment identifier assigned by the email provider.
"""
providerId: String
"""
The original filename.
"""
filename: String
"""
The MIME type.
"""
mimeType: String
"""
The attachment size in bytes.
"""
sizeBytes: Int
"""
The corresponding static-file-service identifier, when uploaded.
"""
sfsId: ID
"""
The content identifier used by inline attachments.
"""
contentId: String
}
"""
A lightweight label embedded in an email message.
"""
type GraphqlSoupEmailMessageLabel {
"""
The label identifier assigned by the email provider.
"""
providerLabelId: String!
"""
The label name.
"""
name: String!
}
"""
Legacy contact-keyed participant, retained for older clients during rollout.
"""
type GraphqlSoupEmailParticipant {
"""
The referenced address-book contact's identifier.
"""
id: ID!
"""
The referenced address-book contact's identifier.
"""
contactId: ID!
"""
The identifier of the link.
"""
linkId: ID!
"""
The name.
"""
name: String
"""
The email.
"""
email: String
"""
The sfs photo url.
"""
sfsPhotoUrl: String
}
"""
A thread-local sender with the display name from their message.
This is an embedded value: different messages from one contact can carry
different names, so the contact ID must not normalize them into one record.
"""
type GraphqlSoupEmailSender {
"""
The referenced address-book contact's identifier.
"""
contactId: ID!
"""
The identifier of the link.
"""
linkId: ID!
"""
The name.
"""
name: String
"""
The email.
"""
email: String
"""
The sfs photo url.
"""
sfsPhotoUrl: String
}
"""
GraphQL representation of the soup email thread.
"""
type GraphqlSoupEmailThread implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque server-only facts used by the offline Mail projection.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common email-thread metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The identifier of the provider.
"""
providerId: String
"""
The identifier of the owner.
"""
ownerId: String!
"""
Whether the thread should appear in the inbox.
"""
inboxVisible: Boolean!
"""
The name.
"""
name: String
"""
The snippet.
"""
snippet: String
"""
The sender email.
"""
senderEmail: String
"""
The sender name.
"""
senderName: String
"""
The sender photo url.
"""
senderPhotoUrl: String
"""
Whether the thread has been read.
"""
isRead: Boolean!
"""
Whether the thread contains a draft.
"""
isDraft: Boolean!
"""
Whether the thread is marked important.
"""
isImportant: Boolean!
"""
The denormalized `email_threads.is_signal` importance classification —
the same flag the soup Importance filter evaluates, distinct from
`is_important` (Gmail's IMPORTANT label).
"""
isSignal: Boolean!
"""
The identifier of the project.
"""
projectId: ID
"""
Timestamp used for email thread sorting, in RFC 3339 format.
"""
sortTs: String!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
The attachment count.
"""
attachmentCount: Int!
"""
The participant count.
"""
participantCount: Int!
"""
Legacy contact-keyed participants. Use senders for message-specific names.
"""
participants: [GraphqlSoupEmailParticipant!]! @deprecated(reason: "Use senders to preserve message-specific display names.")
"""
Senders with message-specific display names, embedded in this thread.
"""
senders: [GraphqlSoupEmailSender!]!
"""
The attachments.
"""
attachments: [GraphqlSoupEmailAttachment!]!
"""
The labels.
"""
labels: [GraphqlSoupEmailLabel!]!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
"""
The canonical identifier of the email link that owns this thread.
"""
linkId: ID!
"""
Timestamp of the latest inbound message, in RFC 3339 format.
"""
latestInboundMessageTs: String
"""
Whether any message was received rather than drafted or sent. Only
threads with received mail can return to the inbox.
"""
hasReceivedMail: Boolean!
"""
Most recent explicit return from an email reminder.
"""
reminderReturnedAt: String
"""
The thread's Focus classification: whether it belongs in Focus, why,
and how important it is. `null` until the thread is classified, and
for threads in inboxes the viewer does not own.
"""
focus: GraphqlEmailThreadFocus
"""
Timestamp of the latest outbound message, in RFC 3339 format: the SENT
view's sort key.
"""
latestOutboundMessageTs: String
"""
Timestamp of the latest message that is not spam, in RFC 3339 format:
the sort key of every mail view except INBOX and SENT.
"""
latestNonSpamMessageTs: String
"""
Complete body-free metadata for local draft edits and discards.
"""
mailDraftState: GraphqlMailDraftState
"""
Latest eligible message for ALL, INBOX, Calendar and Shared, without bodies.
"""
mailAllPreview: GraphqlMailPreviewMessage
"""
Latest eligible draft, even when a newer non-draft exists in the thread.
"""
mailDraftPreview: GraphqlMailPreviewMessage
"""
Latest eligible sent message, without bodies.
"""
mailSentPreview: GraphqlMailPreviewMessage
"""
A page of messages in this thread, newest first.
"""
messages(offset: Int, limit: Int): [GraphqlSoupEmailMessage!]!
"""
The newest non-draft content message in this thread.
"""
latestContentMessage: GraphqlSoupEmailMessage
}
"""
Common GraphQL interface over canonical Soup entity variants.
"""
interface GraphqlSoupEntity {
"""
The canonical entity identifier.
"""
id: ID!
"""
Opaque supplement containing authoritative server-only projection facts.
"""
cacheProjection: SoupCacheProjection
"""
The canonical entity type.
"""
entityType: GraphqlSoupEntityType!
"""
The user-facing entity name, when available.
"""
displayName: String
"""
Metadata shared across entity variants.
"""
metadata: GraphqlEntityMetadata!
"""
Properties assigned to this entity that the viewer may access.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the current viewer.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the current viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The current viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
"""
The newest activity on this entity, newest first.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
}
"""
GraphQL representation of Soup entity types.
"""
enum GraphqlSoupEntityType {
"""
Initiative entity, presented as a project in the frontend.
"""
INITIATIVE
"""
Document entity.
"""
DOCUMENT
"""
Chat entity.
"""
CHAT
"""
Project entity.
"""
PROJECT
"""
Email thread entity.
"""
EMAIL_THREAD
"""
Channel entity.
"""
CHANNEL
"""
Channel message entity.
"""
CHANNEL_MESSAGE
"""
Call entity.
"""
CALL
"""
CRM company entity.
"""
CRM_COMPANY
"""
CRM contact entity.
"""
CRM_CONTACT
"""
Foreign entity.
"""
FOREIGN_ENTITY
"""
Calendar event entity.
"""
CALENDAR_EVENT
"""
AI coding agent session entity.
"""
AGENT_SESSION
"""
Row of a Macro database table.
"""
DATABASE_ROW
}
"""
GraphQL representation of the soup foreign entity.
"""
type GraphqlSoupForeignEntity implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
Foreign entities do not expose a common display name.
"""
displayName: String
"""
Common foreign-entity metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The identifier of the foreign entity.
"""
foreignEntityId: String!
"""
The foreign entity source.
"""
foreignEntitySource: String!
"""
The identifier of the stored for.
"""
storedForId: String!
"""
The stored for auth entity.
"""
storedForAuthEntity: String!
"""
Source-specific metadata.
"""
sourceMetadata: JSON!
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of a Soup initiative.
"""
type GraphqlSoupInitiative implements GraphqlSoupEntity {
"""
The canonical initiative identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata, unavailable for this entity variant.
"""
cacheProjection: SoupCacheProjection
"""
User-visible project name.
"""
displayName: String
"""
Common initiative metadata.
"""
metadata: GraphqlEntityMetadata!
"""
Always null: project descriptions are collaborative surfaces (#7193),
keyed by the initiative id.
"""
descriptionDocumentId: ID @deprecated(reason: "Use ensureInitiativeDescriptionSurface; the description surface id is the initiative id. Remove after 2026-11-30.")
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
Collaborators, independent of assignees.
"""
memberIds: [String!]!
"""
Associated task identifiers visible to this viewer.
"""
taskIds: [ID!]!
"""
Current sharing state.
"""
sharePermission: InitiativeSharePermission!
"""
Number of associated tasks this viewer can see.
"""
taskCount: Int!
"""
Number of completed associated tasks this viewer can see.
"""
completedTaskCount: Int!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
GraphQL representation of the soup project.
"""
type GraphqlSoupProject implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Server-only projection facts are unavailable for projects.
"""
cacheProjection: SoupCacheProjection
"""
User-visible display name.
"""
displayName: String
"""
Common project metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The name.
"""
name: String!
"""
The principal identifier of the owner.
"""
ownerId: String!
"""
The kind of principal `ownerId` names.
"""
ownerType: GraphqlOwnerType!
"""
The identifier of the parent.
"""
parentId: ID
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
The viewed timestamp in RFC 3339 format.
"""
viewedAt: String
"""
The deleted timestamp in RFC 3339 format.
"""
deletedAt: String
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity, when loaded.
"""
frecencyScore: Float
}
"""
A removed reminder entity. Soup no longer returns reminders (#7536); the
type remains so documents from older clients validate. Remove after
2026-11-30.
"""
type GraphqlSoupReminder implements GraphqlSoupEntity {
"""
The unique identifier.
"""
id: ID!
"""
Canonical entity kind.
"""
entityType: GraphqlSoupEntityType!
"""
Opaque cache projection metadata.
"""
cacheProjection: SoupCacheProjection
"""
The reminder's description.
"""
displayName: String
"""
Common reminder metadata.
"""
metadata: GraphqlEntityMetadata!
"""
The entity this reminder was about.
"""
referencedEntity: GraphqlSoupReminderReference
"""
What to remind the user about.
"""
description: String!
"""
Whether the reminder fires once or repeatedly.
"""
scheduleType: GraphqlReminderScheduleType!
"""
The instant a one-shot reminder fires at, in RFC 3339 format.
"""
remindAt: String
"""
The cron expression a recurring reminder fires on.
"""
cron: String
"""
The timezone a recurring reminder's cron is evaluated in.
"""
timezone: String
"""
The next firing, in RFC 3339 format.
"""
nextRunAt: String!
"""
When false, the dispatcher skips this reminder.
"""
enabled: Boolean!
"""
When a one-shot reminder fired, in RFC 3339 format.
"""
completedAt: String
"""
The created timestamp in RFC 3339 format.
"""
createdAt: String!
"""
The updated timestamp in RFC 3339 format.
"""
updatedAt: String!
"""
Properties assigned to this entity that the authenticated user may view.
"""
properties: [GraphqlProperty!]!
"""
Notifications associated with this entity for the authenticated user.
"""
notifications(filter: GraphqlNotificationFilter, limit: Int): [GraphqlNotification!]!
"""
Whether the authenticated viewer has favorited this entity.
"""
isFavorited: Boolean!
"""
The authenticated viewer's effective permission for this entity.
"""
viewerPermission: GraphqlEntityPermission
"""
The newest activity on this entity, newest first. Loaded lazily and
batched across entities; an activity outage degrades to an empty
timeline. Deeper history belongs to the viewer's activity feed.
"""
activity(limit: Int): [GraphqlActivityEvent!]!
"""
The viewer's frecency score for this entity.
"""
frecencyScore: Float
}
"""
The entity a reminder was about. Never returned. Remove after 2026-11-30.
"""
type GraphqlSoupReminderReference {
"""
The referenced entity's id.
"""
id: ID!
"""
The referenced entity's type.
"""
entityType: GraphqlEntityType!
"""
File type, when the reference is a document.
"""
fileType: String
"""
Sub type, when the reference is a task or snippet document.
"""
subType: String
}
"""
Text stored by a string select option.
"""
type GraphqlStringPropertyOptionValue {
"""
Stored text.
"""
value: String!
}
"""
A string property value.
"""
type GraphqlStringPropertyValue {
"""
The stored string.
"""
value: String!
}
"""
Metadata for a task assignment.
"""
type GraphqlTaskAssignedMetadata {
"""
Task identifier.
"""
taskId: String!
"""
Task name.
"""
taskName: String
"""
Task document subtype.
"""
subType: GraphqlNotificationDocumentSubType
"""
Assigning user identifier.
"""
assignedBy: String!
"""
Sender profile-picture URL.
"""
senderProfilePictureUrl: String
}
"""
represents the task subtype fields
"""
type GraphqlTaskSubType {
"""
whether or not the task is complete
"""
isCompleted: Boolean!
}
"""
Team role resolved for the current viewer.
"""
enum GraphqlTeamRole {
"""
Team owner.
"""
OWNER
"""
Team administrator.
"""
ADMIN
"""
Team member.
"""
MEMBER
}
"""
Team permission represented by the viewer's membership role.
"""
type GraphqlTeamRolePermission {
"""
Team membership role held by the viewer.
"""
role: GraphqlTeamRole!
}
"""
A span with absolute instants.
"""
type GraphqlTimedEventTime {
"""
Inclusive start instant in RFC 3339 format.
"""
startsAt: String!
"""
Exclusive end instant in RFC 3339 format.
"""
endsAt: String!
"""
Original IANA time-zone identifier, when supplied.
"""
timeZone: String
}
"""
An update to an existing notification.
"""
type GraphqlUpdatedNotification {
"""
The updated notification.
"""
notification: GraphqlNotification!
}
"""
The authenticated user and their user-scoped data.
"""
type GraphqlUser {
"""
Visible personal and effectively shared definitions, bounded after visibility checks.
"""
savedViews(kind: String, first: Int, after: String): GraphqlSavedViewPage!
"""
An authorized definition or null when not found or not visible.
"""
savedView(id: ID!): GraphqlSavedView
"""
Stable id of the authenticated user.
"""
id: ID!
"""
A page filtered and ordered across the entire authorized table.
"""
databaseViewRows(databaseId: ID!, input: DatabaseViewRowsInput!): DatabaseViewRowsPage!
"""
One initiative accessible to the authenticated viewer.
"""
initiative(initiativeId: ID!): GraphqlSoupInitiative!
"""
A permission-filtered page of task identifiers within an initiative.
"""
initiativeTasks(initiativeId: ID!, input: InitiativeTasksInput): InitiativeTasksPage!
"""
AI routines the authenticated user can access.
"""
scheduledActions: [GraphqlScheduledAction!]!
"""
Authorized property definitions available to this viewer.
"""
propertyDefinitions(scope: GraphqlPropertyDefinitionScope!, forEntityType: GraphqlPropertyEntityType): [GraphqlPropertyDefinition!]!
"""
Select options available to the viewer for one property definition.
"""
propertyOptions(propertyDefinitionId: ID!): [GraphqlPropertyOption!]!
"""
The authenticated user's favorites in manual order, optionally
restricted by entity type and entity id.
"""
favorites(filter: FavoritesFilterInput): [GraphqlFavorite!]!
"""
Non-deleted projects the authenticated user can access, as a flat list.
Clients build the Drive sidebar tree from `parentId`. Membership is
gated by `entity_access` (not view history).
"""
folders: [GraphqlSoupProject!]!
"""
A page of activity, newest first: by default the authenticated
user's own, delegated actions included; in the `TEAM` scope, their
teammates' activity on entities shared with the user.
"""
activity(input: ActivityFeedInput!): GraphqlActivityPage!
"""
The newest activity on a database the authenticated user can view,
newest first. Databases are not Soup items, so this stands in for the
`activity` edge Soup entities carry.
"""
databaseActivity(databaseId: ID!, limit: Int): [GraphqlActivityEvent!]!
"""
The newest activity on a form the authenticated user can edit, newest
first. Forms are not Soup items, so this stands in for the `activity`
edge Soup entities carry.
"""
formActivity(formId: ID!, limit: Int): [GraphqlActivityEvent!]!
"""
The authenticated user's activity over the trailing year, bucketed
into local dates in the requested time zone.
"""
activityOverview(input: ActivityOverviewInput!): GraphqlActivityOverview!
"""
Every calendar visible across owned and delegated inboxes, primaries
and writables first.
"""
calendars: [GraphqlCalendar!]!
"""
One page of occurrences overlapping the viewport, across owned and
delegated inboxes, ordered by start. `watermark` is read before the
occurrences, so the page reflects at least every change it covers.
"""
calendarOccurrences(input: CalendarRangeInput!): GraphqlCalendarOccurrencePage!
"""
Changes to the viewer's calendars after `since`, one bounded page at a
time. An empty `since` returns only the current watermark.
"""
calendarChanges(input: CalendarChangesInput!): GraphqlCalendarChanges!
"""
A page of the authenticated user's work feed, newest first: items
with outstanding attention (notifications, inbox Signal email,
reminders) and, in `WORK` mode, work the user recently did. Each
item carries its notifications stacked for presentation.
"""
workFeed(input: WorkFeedInput): WorkFeedPage!
"""
The agent sessions `accountIds` registered as their work that the
authenticated user can view, newest first, at most 50 accounts.
Registrations of sessions the user cannot view are completely hidden.
"""
registeredWork(accountIds: [ID!]!): [GraphqlRegisteredWork!]!
"""
A page of the authenticated user's notifications inbox, newest group
first: their pending notifications grouped by the entity they are
filed under and cut into rows, one per conversation thread, channel
top level, email thread, task, request or agent session.
"""
notificationInbox(input: NotificationInboxInput): NotificationInboxPage!
"""
Labels across every owned or delegated inbox accessible to the authenticated user.
"""
emailLabels: [GraphqlSoupEmailLabel!]!
"""
Enriched owned or delegated email links accessible to the authenticated user.
"""
emailLinks: [GraphqlEmailLink!]!
"""
Inspect a queued send after reconnect or restart without resending it.
"""
pendingEmailSends(after: String): PendingEmailSends!
"""
Inspect a queued send after reconnect or restart without resending it.
"""
emailSendAttempt(input: EmailSendAttemptInput!): EmailSendAttemptPayload
"""
Fetch one accessible email thread by its canonical identifier.
"""
emailThread(input: EmailThreadInput!): GraphqlSoupEmailThread
"""
The viewer's Focus: threads in their own inboxes worth their attention,
newest first by latest message time in either direction, with mail in
the last `days` days (default 30, at most 90). Each thread carries a
`focus` field that explains why.
"""
emailFocus(days: Int): [GraphqlSoupEmailThread!]!
"""
Fetch one accessible agent session by id, with its protocol log
reachable through `log`.
"""
agentSession(sessionId: ID!): GraphqlSoupAgentSession
"""
Fetch one accessible Soup entity, read from the primary so an entity
opened right after it is created or edited reflects that write.
"""
soupEntity(input: SoupEntityInput!): GraphqlSoupEntity
"""
Fetch Soup items nested into grouping bins.
"""
groupSoup(input: GroupedSoupInput!): GroupedSoup!
"""
Fetch a page of Soup items using the existing Soup filter AST format.
"""
soup(input: SoupInput!): SoupPage!
}
"""
A removed WhatsApp group message notification. Never returned; external
chat messages use `GraphqlExternalChatMessageMetadata`. Remove after
2026-11-30.
"""
type GraphqlWhatsappGroupMessageMetadata {
"""
Display name of the group.
"""
groupName: String!
"""
Message to open within the group.
"""
messageId: ID!
}
"""
GraphQL representation of grouped Soup items.
"""
type GroupedSoup {
"""
Bins containing the grouped Soup items.
"""
bins: [GraphqlSoupBin!]!
}
"""
Input for continuing a single grouped Soup bin.
"""
input GroupedSoupContinuationInput {
"""
The field used to divide Soup items into bins.
"""
groupBy: GraphqlGroupByInput!
"""
The grouping key of the bin to continue.
"""
groupKey: String!
"""
Opaque cursor returned for the bin by a previous grouped query.
"""
cursor: String!
}
"""
Input for starting a grouped Soup query.
"""
input GroupedSoupInitialInput {
"""
The field used to divide Soup items into bins.
"""
groupBy: GraphqlGroupByInput!
"""
Maximum number of items to return per bin. Defaults to 20, max 500.
"""
limit: Int
"""
Sort order within each bin. Defaults to `VIEWED_UPDATED`.
Grouped PROPERTY reads retain calendar events; flat PROPERTY reads do not.
"""
sortMethod: GraphqlSimpleSortMethod
"""
Property definition selected for numeric property sorting.
"""
sortPropertyDefinitionId: ID
"""
Direction of property values. Defaults to DESC.
"""
sortDirection: GraphqlSortDirection
"""
AST-shaped filters applied to each Soup entity type.
"""
filters: GraphqlEntityFilterAst
}
"""
Input for `Query.groupSoup`.
"""
input GroupedSoupInput @oneOf {
"""
Start a new grouped Soup query.
"""
initial: GroupedSoupInitialInput
"""
Continue one bin from a cursor returned by a previous grouped query.
"""
continuation: GroupedSoupContinuationInput
}
"""
One property value set when an initiative is created.
"""
input InitialPropertyValueInput {
"""
Property definition to set.
"""
propertyDefinitionId: ID!
"""
Value, in the same shape `setEntityProperty` accepts.
"""
value: GraphqlSetPropertyValue!
}
"""
Grant to a shared channel.
"""
type InitiativeChannelShare {
"""
Channel receiving access.
"""
channelId: ID!
"""
Access granted to the channel.
"""
accessLevel: GraphqlEntityAccessLevel!
}
"""
A channel sharing patch.
"""
input InitiativeChannelShareInput {
"""
Kind of channel grant change.
"""
operation: InitiativeChannelShareOperation!
"""
Channel identifier.
"""
channelId: ID!
"""
Grant level for add or replace.
"""
accessLevel: GraphqlEntityAccessLevel
}
"""
Mutation of one channel grant.
"""
enum InitiativeChannelShareOperation {
"""
Add a grant.
"""
ADD
"""
Remove a grant.
"""
REMOVE
"""
Replace a grant.
"""
REPLACE
}
"""
Link recipients supported by the sharing domain.
"""
enum InitiativeLinkShare {
"""
Everyone with the link.
"""
PUBLIC
"""
Members of the owner's team with the link.
"""
TEAM
}
"""
Typed sharing state for an initiative.
"""
type InitiativeSharePermission {
"""
Stable identifier of the sharing policy.
"""
id: ID!
"""
Audience permitted through the link, when enabled.
"""
linkShare: InitiativeLinkShare
"""
Permission granted to the link audience.
"""
linkShareAccessLevel: GraphqlEntityAccessLevel
"""
Explicit permission granted to the owner's team.
"""
teamShareAccessLevel: GraphqlEntityAccessLevel
"""
Owner of the shared initiative.
"""
owner: String!
"""
Explicit channel sharing grants.
"""
channelSharePermissions: [InitiativeChannelShare!]!
}
"""
Sharing patch; omitted and null fields have distinct meanings.
"""
input InitiativeSharePermissionInput {
"""
Omit to preserve, null to disable link sharing.
"""
linkShare: InitiativeLinkShare
"""
Omit to preserve, null to reset to the domain default.
"""
linkShareAccessLevel: GraphqlEntityAccessLevel
"""
Omit to preserve, null to disable team sharing.
"""
teamShareAccessLevel: GraphqlEntityAccessLevel
"""
Changes to channel grants.
"""
channelSharePermissions: [InitiativeChannelShareInput!]
}
"""
Cursor pagination for visible initiative tasks.
"""
input InitiativeTasksInput {
"""
Page size, one through one hundred.
"""
limit: Int
"""
Opaque continuation from the previous page.
"""
cursor: String
}
"""
A page of visible task references.
"""
type InitiativeTasksPage {
"""
Visible task identifiers in the current page.
"""
taskIds: [ID!]!
"""
Continuation when another visible page exists.
"""
nextCursor: String
"""
Total tasks visible to this viewer.
"""
total: Int!
}
"""
Add guests to an event without touching anyone already invited.
"""
input InviteCalendarEventGuestsInput {
"""
Event to add guests to.
"""
eventId: ID!
"""
Calendar whose copy of the event is written, for an event synced from
more than one calendar. Omit to write the canonical copy.
"""
calendarId: ID
"""
Guests to add; anyone already on the event is skipped.
"""
guests: [CalendarGuestInput!]!
"""
How much of a recurring series gains the guests.
"""
scope: GraphqlCalendarUpdateScope!
"""
Original-start key of the occurrence; required with `THIS_EVENT`.
"""
recurrenceId: String
}
"""
A scalar that can represent any JSON value.
"""
scalar JSON
"""
Input for marking an email thread as seen.
"""
input MarkEmailThreadSeenInput {
"""
Email thread to mark as seen.
"""
threadId: ID!
}
"""
Input for marking an email thread unread.
"""
input MarkEmailThreadUnreadInput {
"""
Email thread to mark unread; its inbox determines the UNREAD label.
"""
threadId: ID!
}
"""
Input for marking one notification of a row done.
"""
input MarkNotificationInboxNotificationDoneInput {
"""
The row showing the notification.
"""
rowId: ID!
"""
The notification, as the row lists it.
"""
notificationId: ID!
"""
The inbox the row's group is placed in.
"""
scope: NotificationInboxScopeInput
}
"""
The result of marking one notification of a row done.
"""
type MarkNotificationInboxNotificationDonePayload {
"""
The row's group's place in the requested inbox.
"""
patches: [NotificationInboxPatch!]!
"""
Opaque token that reverses exactly this operation.
"""
undoToken: String!
}
"""
Input for marking inbox rows done.
"""
input MarkNotificationInboxRowsDoneInput {
"""
The rows to complete, at most 200.
"""
rows: [NotificationInboxRowTargetInput!]!
}
"""
The result of marking inbox rows done.
"""
type MarkNotificationInboxRowsDonePayload {
"""
The completed rows; remove them from every inbox. Rows that were
already gone are included.
"""
rowIds: [ID!]!
"""
Opaque token that reverses exactly this operation.
"""
undoToken: String!
}
"""
Input for marking inbox rows seen.
"""
input MarkNotificationInboxRowsSeenInput {
"""
The rows to mark seen, at most 200.
"""
rowIds: [ID!]!
"""
The inbox the updated groups are placed in.
"""
scope: NotificationInboxScopeInput
}
"""
The result of marking inbox rows seen.
"""
type MarkNotificationInboxRowsSeenPayload {
"""
The updated groups' places in the requested inbox.
"""
patches: [NotificationInboxPatch!]!
}
"""
Input for marking work feed items done.
"""
input MarkWorkFeedItemsDoneInput {
"""
The items to complete, at most 200.
"""
items: [WorkFeedDoneItemInput!]!
}
"""
The result of marking work feed items done.
"""
type MarkWorkFeedItemsDonePayload {
"""
The completed items; remove them from every feed. Items that were
already gone are included.
"""
itemIds: [ID!]!
"""
Opaque token that reverses exactly this operation.
"""
undoToken: String!
}
"""
One entity move in a batch.
"""
input MoveEntityInput {
"""
Entity to move.
"""
entity: EntityRefInput!
"""
Destination project id. Omit or pass null to move to the root.
"""
projectId: ID
}
"""
Canonical entity reference used to select notifications for updating.
"""
input NotificationEntityInput {
"""
Canonical entity type.
"""
entityType: GraphqlEntityType!
"""
Canonical entity identifier.
"""
entityId: ID!
}
"""
Who a row is from: a person, an agent, or Macro itself.
"""
type NotificationInboxActor {
"""
The kind of principal.
"""
kind: NotificationInboxActorKind!
"""
The user id for a user, the bot id for an agent; absent for Macro.
Not `id`: the client cache reads an `id` field as entity identity.
"""
principalId: String
"""
The display name when the row carries it (an agent's bot name);
users are looked up by id.
"""
name: String
}
"""
The kind of principal a row is from. Values may be added; present one
you do not know without an author.
"""
enum NotificationInboxActorKind {
"""
A Macro user.
"""
USER
"""
An agent.
"""
AGENT
"""
Macro itself.
"""
MACRO
}
"""
The matching rows of the notifications filed under one entity. Entries
belong to one inbox scope and have no id of their own; rows are shared.
"""
type NotificationInboxEntry {
"""
The group the rows are filed under: `<entity type>:<entity id>`.
"""
groupId: ID!
"""
The entity the rows are filed under.
"""
entity: GraphqlSoupEntity!
"""
Where the entry sits, in RFC 3339: the group's newest pending
notification.
"""
sortAt: String!
"""
The matching rows, newest first; never empty.
"""
rows: [NotificationInboxRow!]!
}
"""
A group with no matching row left in the subscribed inbox: done,
filtered out or inaccessible. The entity itself is not necessarily
deleted.
"""
type NotificationInboxEntryRemoved {
"""
The removed group's id.
"""
groupId: ID!
}
"""
A group that belongs in the subscribed inbox, with its current rows and
placement. Insert it, or move it to its new `sortAt`.
"""
type NotificationInboxEntryUpserted {
"""
The entry.
"""
entry: NotificationInboxEntry!
}
"""
Page request for the viewer's notification inbox.
"""
input NotificationInboxInput {
"""
Which rows the inbox shows.
"""
scope: NotificationInboxScopeInput
"""
Entries per page; defaults to 50, capped at 100.
"""
limit: Int
"""
Opaque cursor from the previous page's `nextCursor`; absent for the
first page. Send it with the same scope.
"""
cursor: String
}
"""
Changes may have been missed: refetch the inbox.
"""
type NotificationInboxInvalidated {
"""
Always true.
"""
refresh: Boolean!
}
"""
One page of the viewer's notification inbox, newest group first.
"""
type NotificationInboxPage {
"""
The page's entries.
"""
entries: [NotificationInboxEntry!]!
"""
Cursor for the next page; absent once the inbox is exhausted.
"""
nextCursor: String
"""
Where this page's read stopped, the position `nextCursor` resumes
after; absent once the inbox is exhausted. A filtered page can read
past its last entry, so a live change placed after that entry but not
after this position belongs to this page rather than a later one.
"""
nextPosition: NotificationInboxPosition
}
"""
One change to an inbox's membership, placement or rows.
"""
union NotificationInboxPatch = NotificationInboxEntryUpserted | NotificationInboxEntryRemoved | NotificationInboxInvalidated
"""
A place in the inbox's order: newest `sortAt` first, then entity id
descending.
"""
type NotificationInboxPosition {
"""
The sort time, RFC 3339.
"""
sortAt: String!
"""
The entity id that breaks ties at `sortAt`.
"""
entityId: String!
}
"""
One inbox row: the notifications shown together for one thread, a
channel's top level, an email thread, a task, a request or a review. A
row's contents depend only on the viewer's notifications, so one id is
one row in every scope.
"""
type NotificationInboxRow {
"""
Stable per-viewer row id: `<groupId>#<slot>`. Opaque.
"""
id: ID!
"""
The row's kind.
"""
rowType: NotificationInboxRowType!
"""
For a thread row, the channel root message or discussion root
comment it is about.
"""
threadId: String
"""
When the row's newest shown notification was created, in RFC 3339.
"""
latestAt: String!
"""
Who the row is from, per its newest shown notification; absent when
that is no one in Macro (outside email senders, GitHub users).
"""
actor: NotificationInboxActor
"""
What the viewer can do from the row, in presentation order; empty
when the row only opens.
"""
actions: [NotificationInboxRowAction!]!
"""
Whether the row is unread.
"""
unseen: Boolean!
"""
How many notifications the row shows.
"""
count: Int!
"""
Opaque token of what the row stands for; send it with done so
notifications that arrive later stay active.
"""
revision: String!
"""
The row's shown notifications, newest first. Defaults to 20, capped
at 100; `count` is the full size.
"""
notifications(limit: Int): [GraphqlNotification!]!
}
"""
One thing the viewer can do from a row, described as data. Perform it
through the API of the thing it acts on; the inbox only says it is
available.
"""
type NotificationInboxRowAction {
"""
What the action does.
"""
kind: NotificationInboxRowActionKind!
"""
What the action acts on when it is not the row's group: an access or
join request.
"""
targetId: ID
"""
The page the action opens outside Macro, such as a pull request.
"""
url: String
}
"""
What the viewer can do from a row. Values are added with the row types
that offer them; skip one you do not know.
"""
enum NotificationInboxRowActionKind {
"""
Open what the row is about.
"""
OPEN
"""
Answer the agent that is waiting for the viewer.
"""
ANSWER
"""
Review the pull request at `url`.
"""
REVIEW
"""
Grant the access request `targetId`.
"""
APPROVE
"""
Refuse the access request `targetId`.
"""
DENY
"""
Accept the join request `targetId`.
"""
ACCEPT
"""
Decline the join request `targetId`.
"""
DECLINE
}
"""
One row to mark done.
"""
input NotificationInboxRowTargetInput {
"""
The row's id.
"""
id: ID!
"""
The row's `revision` the caller observed. Notifications newer than it
stay active. Omit to acknowledge everything current.
"""
revision: String
}
"""
The kinds of notification inbox row. Values are added as the inbox
learns new sources; present a value you do not know as a generic row.
"""
enum NotificationInboxRowType {
"""
An agent session's or AI chat's latest response or question.
"""
AGENT
"""
An email thread.
"""
EMAIL
"""
A top-level channel message that mentions the viewer, with its thread.
"""
CHANNEL_MENTION
"""
A channel's top-level messages, reactions to them and invites.
"""
CHANNEL_MESSAGES
"""
A channel thread's replies, mentions and reactions.
"""
CHANNEL_THREAD
"""
A top-level discussion comment that mentions the viewer, with its
thread.
"""
DISCUSSION_MENTION
"""
An entity's top-level discussion comments.
"""
DISCUSSION_MESSAGES
"""
One discussion thread's replies.
"""
DISCUSSION_THREAD
"""
A task assigned to the viewer.
"""
TASK
"""
A GitHub pull request's activity.
"""
PULL_REQUEST
"""
Reminders of an upcoming calendar event.
"""
CALENDAR_EVENT
"""
A request to join a calendar event the viewer shared.
"""
CALENDAR_JOIN_REQUEST
"""
A request for access to something the viewer can share.
"""
ACCESS_REQUESTED
"""
Access the viewer requested was granted.
"""
ACCESS_GRANTED
}
"""
Which rows a notification inbox shows. Pages, subscriptions, seen and
undo for one inbox send the same scope.
"""
input NotificationInboxScopeInput {
"""
Row kinds to include; omitted or empty means every kind.
"""
rowTypes: [NotificationInboxRowType!]
"""
Only unread rows; pages, cursors and updates then cover unread rows
alone. Defaults to false.
"""
unreadOnly: Boolean
}
"""
The notification state as represented by GraphQL variables and responses.
"""
enum NotificationState {
"""
Not yet acknowledged.
"""
UNSEEN
"""
Acknowledged but not completed.
"""
SEEN
"""
Completed.
"""
DONE
}
"""
Explicit notification status operation exposed by GraphQL.
"""
enum NotificationUpdateOperation {
"""
Mark notifications as seen.
"""
MARK_SEEN
"""
Mark notifications as done.
"""
MARK_DONE
"""
Mark notifications as not done.
"""
MARK_UNDONE
}
"""
An unresolved send owned by the authenticated actor, possibly from another device.
"""
type PendingEmailSend {
"""
Inbox needed to address the attempt, including after message deletion.
"""
linkId: ID!
"""
Current authoritative status.
"""
attempt: EmailSendAttemptPayload!
}
"""
A bounded page of unresolved sends, newest first.
"""
type PendingEmailSends {
"""
Authorized sends.
"""
attempts: [PendingEmailSend!]!
"""
Opaque cursor for the next page.
"""
nextCursor: String
}
"""
Input for recording authenticated channel activity.
"""
input RecordChannelActivityInput {
"""
Channel receiving the activity update.
"""
channelId: ID!
"""
Kind of activity to record.
"""
activityType: ChannelActivityType!
}
"""
One entity rename in a batch.
"""
input RenameEntityInput {
"""
Entity to rename.
"""
entity: EntityRefInput!
"""
New user-visible display name.
"""
displayName: String!
}
"""
Input for persisting the authenticated user's complete favorites order.
"""
input ReorderFavoritesInput {
"""
Favorited entities in the desired order.
"""
favorites: [EntityRefInput!]!
}
"""
Resolve exactly the message revision and provider version the user reviewed.
"""
input ResolveEmailMessageOperationInput {
"""
Stable Macro message ID.
"""
messageId: ID!
"""
Opaque revision returned by operationStatus.
"""
revision: String!
"""
Opaque provider version returned by operationStatus.
"""
remoteVersion: String
"""
Explicit recovery action.
"""
action: EmailMessageResolutionAction!
"""
Required only for RetrySend; never inferred from a timeout.
"""
acceptDuplicateRisk: Boolean! = false
}
"""
Set the viewer's RSVP on an event.
"""
input RespondToCalendarEventInput {
"""
Event to answer.
"""
eventId: ID!
"""
Calendar whose copy of the event is answered, for an event synced
from more than one calendar. Omit to answer on the canonical copy.
"""
calendarId: ID
"""
The response to record.
"""
response: GraphqlCalendarAttendeeResponseStatus!
"""
How much of a recurring series the response covers. Omit to let
`recurrenceId` decide: the identified occurrence alone when one is
supplied, otherwise the whole series.
"""
scope: GraphqlCalendarRsvpScope
"""
Original-start key of the occurrence the response targets.
"""
recurrenceId: String
"""
The owned connected address whose attendance is changed. Omit to
answer as the inbox the addressed copy syncs through.
"""
respondingEmail: String
}
"""
One recipient of an email draft.
"""
input SaveEmailDraftContactInput {
"""
Recipient email address.
"""
email: String!
"""
Recipient display name, when known.
"""
name: String
"""
Recipient photo URL, when known.
"""
photoUrl: String
}
"""
Input for creating or updating an email draft.
The draft ID is a client-generated handle so a save queued offline stays
an idempotent upsert when it replays later — possibly after an app
restart, possibly more than once. Handles are untrusted input and never
become primary keys: the server resolves them through a caller-scoped
mapping to server-minted rows. Thread identifiers are hints: the server
derives authoritative thread linkage from the reply target or the
existing draft.
"""
input SaveEmailDraftInput {
"""
Generation from the last loaded draft. Omitted by legacy clients.
"""
draftGeneration: Int
"""
Verified sender address for the selected inbox. Absent selects its primary address.
"""
senderEmail: String
"""
Draft handle: a client-generated ID, or a server ID from a fetched
draft. Resolved scoped to the caller's inboxes, and bound to the
server row the save settles on, so replays converge on one draft.
"""
draftId: ID!
"""
Sending inbox. Absent means the caller's primary inbox. Carried as a
variable (not a header) so queued offline saves replay with it.
"""
linkId: ID
"""
Message this draft replies to, when it is a reply.
"""
replyingToId: ID
"""
Provider-assigned draft ID, when the draft already exists upstream.
"""
providerId: String
"""
Provider-assigned thread ID hint.
"""
providerThreadId: String
"""
Thread handle. For replies this is a hint the server may override.
For compose drafts (no reply target) it is client-generated: an
unresolvable handle gets a fresh server-minted thread and is bound
to it, so saves queued offline replay against one thread.
"""
threadDbId: ID
"""
Draft subject line.
"""
subject: String!
"""
To recipients.
"""
to: [SaveEmailDraftContactInput!]
"""
Cc recipients.
"""
cc: [SaveEmailDraftContactInput!]
"""
Bcc recipients.
"""
bcc: [SaveEmailDraftContactInput!]
"""
Plain text body.
"""
bodyText: String
"""
HTML body, base64 URL-safe (no padding) encoded; the server decodes
and sanitizes it before storing.
"""
bodyHtml: String
"""
Macro body.
"""
bodyMacro: String
"""
Scheduled send time (RFC 3339), when the draft is scheduled.
"""
sendTime: String
}
"""
Result of creating or updating an email draft.
"""
type SaveEmailDraftPayload {
"""
Server-confirmed draft ID: the server-minted row the input's handle
resolved (and is now bound) to. Use it for server-addressed calls;
the handle keeps working for queued saves and deletes.
"""
draftId: ID!
"""
The saved draft as a full message record — selected with the thread
page's message fragment so the client cache can hold the draft as a
complete entity (its optimistic layer must satisfy every field the
thread page reads, or the whole page read misses).
"""
draft: GraphqlSoupEmailMessage!
"""
The draft's thread, reloaded as its authoritative cache record.
"""
thread: GraphqlSoupEmailThread!
}
"""
Explicit sharing action: an omitted input leaves sharing unchanged; null team ID makes it private.
"""
input SavedViewSharingInput {
"""
Current team to share with; null explicitly removes sharing.
"""
teamId: ID
}
"""
Immutable content approved by the user.
"""
input SendEmailAttemptInput {
"""
Saved signature HTML captured at Send; empty means no signature.
"""
signatureHtml: String
"""
Stable attempt and sending inbox.
"""
attempt: EmailSendAttemptInput!
"""
Full message snapshot; optional send time preserves Send Later across retries.
"""
message: SaveEmailDraftInput!
"""
Per-message signature preference.
"""
includeSignature: Boolean
"""
Completed draft attachment IDs.
"""
attachmentIds: [ID!]!
"""
Original attachment IDs for forwarded attachments.
"""
forwardedAttachmentIds: [ID!]!
"""
Editor HTML before the watermark, encoded like message HTML.
"""
restoreBodyHtml: String
"""
Editor plain text before the watermark.
"""
restoreBodyText: String
"""
Editor document before the watermark.
"""
restoreBodyMacro: String
}
"""
Send admission or cancellation and the updated conversation.
"""
type SendEmailAttemptPayload {
"""
Admission/cancellation result and hydrated message.
"""
attempt: EmailSendAttemptPayload!
"""
Updated thread, absent for cancellation before admission.
"""
thread: GraphqlSoupEmailThread
}
"""
Online delivery command. The draft handle is required so a response lost
after enqueue cannot turn a retry into a second, unrelated message.
"""
input SendEmailMessageInput {
"""
Complete latest draft revision, including inbox and sender address.
"""
draft: SaveEmailDraftInput!
"""
Per-message override for the inbox's signature policy.
"""
includeSignature: Boolean
}
"""
Confirmed delivery identity. These fields describe an operation result, not
a globally normalized entity; there is deliberately no `id` field.
"""
type SendEmailMessagePayload {
"""
Persisted message queued for delivery.
"""
messageId: ID!
"""
Persisted thread containing the message.
"""
threadId: ID!
"""
Authorized inbox used for delivery.
"""
linkId: ID!
"""
End of the undo-send window, in RFC 3339 format.
"""
sendTime: String
}
"""
Input for archive-based Done and its inverse. No client label lookup is needed.
"""
input SetEmailThreadArchivedInput {
"""
Thread whose inbox membership should change.
"""
threadId: ID!
"""
True for Done; false for Mark Not Done or Undo.
"""
archived: Boolean!
}
"""
Set one mailbox fact without looking up provider labels on the client.
"""
input SetEmailThreadStateInput {
"""
Accessible thread to change.
"""
threadId: ID!
"""
Semantic mailbox fact.
"""
field: EmailThreadStateField!
"""
Desired state.
"""
value: Boolean!
}
"""
Input for archive-based Done and its inverse on many threads at once.
"""
input SetEmailThreadsArchivedInput {
"""
Threads whose inbox membership should change, at most 100.
"""
threadIds: [ID!]!
"""
True for Done; false for Mark Not Done or Undo.
"""
archived: Boolean!
}
"""
Result of archiving or unarchiving many email threads.
"""
type SetEmailThreadsArchivedPayload {
"""
Primary-backed record of every requested thread the caller can still
load, changed or not.
"""
threads: [GraphqlSoupEmailThread!]!
"""
Requested threads whose archive state could not change.
"""
failedThreadIds: [ID!]!
}
"""
Input for assigning or updating an entity property.
"""
input SetEntityPropertyInput {
"""
Type of entity receiving the property.
"""
entityType: GraphqlPropertyTargetEntityType!
"""
Identifier of the entity receiving the property.
"""
entityId: String!
"""
Identifier of the property definition to assign.
"""
propertyDefinitionId: ID!
"""
Omit or pass null to attach the property without a value.
"""
value: GraphqlSetPropertyValue
}
"""
GraphQL result of setting an entity's favorite state.
"""
type SetFavoritePayload {
"""
Entity mutation result, including normalized Soup cache effects.
"""
result: GraphqlEntityMutationResult!
"""
Persisted favorite after an add, or `null` after a removal.
"""
favorite: GraphqlFavorite
}
"""
Opaque versioned supplement containing authoritative server-only facts.
"""
scalar SoupCacheProjection
"""
Input for continuing a Soup query.
"""
input SoupContinuationInput {
"""
Opaque cursor returned by a previous GraphQL Soup response.
"""
cursor: String!
"""
Whether to return expanded Soup items. Defaults to true.
"""
expand: Boolean
"""
Email preview view used when hydrating email Soup items.
"""
emailView: GraphqlEmailView
"""
Direction to order the page in. Defaults to DESC.
The cursor does not carry it, so re-send whatever the initial query
used or the continuation flips order mid-list.
"""
sortDirection: GraphqlSortDirection
}
"""
Input for fetching one Soup entity by its type and identifier.
"""
input SoupEntityInput {
"""
The Soup type of the entity.
"""
entityType: GraphqlSoupEntityType!
"""
The entity identifier.
"""
entityId: ID!
}
"""
Input for starting a Soup query.
"""
input SoupInitialInput {
"""
Maximum number of items to return. Defaults to 20, max 500.
"""
limit: Int
"""
Whether to return expanded Soup items. Defaults to true.
"""
expand: Boolean
"""
Timestamp or selected numeric property sort. Defaults to VIEWED_AT.
Frecency is not supported by this GraphQL adapter.
Flat PROPERTY reads omit calendar events, email, channels, calls, companies, and agent sessions.
"""
sortMethod: GraphqlSimpleSortMethod
"""
Property definition selected for numeric property sorting.
"""
sortPropertyDefinitionId: ID
"""
Email preview view used when hydrating email Soup items.
"""
emailView: GraphqlEmailView
"""
AST-shaped filters applied to each Soup entity type.
"""
filters: GraphqlEntityFilterAst
"""
Direction to order the page in. Defaults to DESC.
"""
sortDirection: GraphqlSortDirection
}
"""
Input for `Query.soup`.
"""
input SoupInput @oneOf {
"""
Start a new Soup query.
"""
initial: SoupInitialInput
"""
Continue a Soup query from an opaque cursor.
"""
continuation: SoupContinuationInput
}
"""
Page returned by `Query.soup`.
"""
type SoupPage {
"""
Items in the current page.
"""
items: [GraphqlSoupEntity!]!
"""
Opaque cursor for the next page, if one exists.
"""
nextCursor: String
}
"""
Realtime Soup patch represented as exactly one update or cache deletion.
"""
union SoupPatch = SoupUpdated | GraphqlCacheDeletion
"""
Root entry point for the complete GraphQL API.
"""
type SoupQueryRoot {
"""
The authenticated user.
"""
user: GraphqlUser!
}
"""
GraphQL representation of a created or updated Soup entity.
"""
type SoupUpdated {
"""
The hydrated entity for this update.
"""
item: GraphqlSoupEntity!
}
"""
A span with absolute instants.
"""
input TimedEventTimeInput {
"""
Inclusive start instant in RFC 3339 format.
"""
startsAt: String!
"""
Exclusive end instant in RFC 3339 format.
"""
endsAt: String!
"""
IANA time-zone identifier the event is anchored to.
"""
timeZone: String
}
"""
Input for undoing one mark-done.
"""
input UndoNotificationInboxRowsDoneInput {
"""
The `undoToken` the mark-done returned.
"""
undoToken: String!
"""
The inbox the restored groups are placed in.
"""
scope: NotificationInboxScopeInput
}
"""
The result of undoing a mark-done.
"""
type UndoNotificationInboxRowsDonePayload {
"""
The restored groups' places in the requested inbox.
"""
patches: [NotificationInboxPatch!]!
}
"""
Input for undoing one mark-done.
"""
input UndoWorkFeedItemsDoneInput {
"""
The `undoToken` the mark-done returned.
"""
undoToken: String!
"""
The feed the restored items are placed in.
"""
scope: WorkFeedScopeInput
}
"""
The result of undoing a mark-done.
"""
type UndoWorkFeedItemsDonePayload {
"""
The restored items' places in the requested feed.
"""
patches: [WorkFeedPatch!]!
}
"""
Patch an event; omitted fields are left untouched.
"""
input UpdateCalendarEventInput {
"""
Event to patch.
"""
eventId: ID!
"""
Calendar whose copy of the event is patched, for an event synced from
more than one calendar. Omit to patch the canonical copy.
"""
calendarId: ID
"""
Replacement title; an empty string clears it.
"""
title: String
"""
Replacement description; an empty string clears it.
"""
description: String
"""
Replacement location; an empty string clears it.
"""
location: String
"""
Replacement time.
"""
time: CalendarEventTimeInput
"""
Replacement attendee list.
"""
attendees: [CalendarAttendeeInput!]
"""
Replacement recurrence properties; an empty list clears them.
"""
recurrenceLines: [String!]
"""
Replacement visibility.
"""
visibility: GraphqlCalendarEventVisibility
"""
Replacement transparency.
"""
transparency: GraphqlCalendarEventTransparency
"""
Replacement reminder configuration.
"""
reminders: CalendarRemindersInput
"""
Conference change; omit to leave the conference untouched.
"""
conference: GraphqlCalendarConferenceChange
"""
Replacement out-of-office properties, applied only to an event that is
already out-of-office.
"""
outOfOffice: CalendarOutOfOfficeInput
"""
Replacement guest policy; only the organizer of a Google event may
change it, for the whole event or series.
"""
guestPolicy: CalendarGuestPolicyInput
"""
How much of a recurring series the update covers. Omit to let
`recurrenceId` decide: the identified occurrence alone when one is
supplied, otherwise the whole event or series.
"""
scope: GraphqlCalendarUpdateScope
"""
Original-start key of the occurrence the update targets.
"""
recurrenceId: String
}
"""
Input for adding or removing a label from an email thread.
"""
input UpdateEmailThreadLabelInput {
"""
Email thread whose label assignment will change.
"""
threadId: ID!
"""
Label to add or remove.
"""
labelId: ID!
"""
Whether the label should be present after the mutation.
"""
value: Boolean!
}
"""
Input for applying option deltas across one entity's properties.
"""
input UpdateEntityPropertyOptionsInput {
"""
Type of entity whose properties are changing.
"""
entityType: GraphqlPropertyTargetEntityType!
"""
Identifier of the entity whose properties are changing.
"""
entityId: String!
"""
Per-property option deltas applied in one transaction.
"""
properties: [EntityPropertyOptionDeltaInput!]!
}
"""
One share-policy update in a batch.
"""
input UpdateEntitySharePolicyInput {
"""
Entity whose share policy should change.
"""
entity: EntityRefInput!
"""
New link, explicit team, and channel policy values.
"""
policy: EntitySharePolicyInput!
}
"""
Partial initiative update; collaborator lists replace the previous list.
"""
input UpdateInitiativeInput {
"""
Replacement name.
"""
name: String
"""
Full replacement collaborator list, authorized by the domain service.
"""
memberIds: [String!]
"""
Sharing patch, authorized by the domain service.
"""
sharePermission: InitiativeSharePermissionInput
}
"""
Input for updating all notifications associated with any requested entity.
"""
input UpdateNotificationsForEntityInput {
"""
Canonical entities whose notifications should be updated.
"""
entities: [NotificationEntityInput!]!
"""
Status operation applied to every matching notification.
"""
operation: NotificationUpdateOperation!
}
"""
Input for updating notification statuses.
"""
input UpdateNotificationsInput {
"""
User notification identifiers to update.
"""
notificationIds: [ID!]!
"""
Status operation applied to every requested notification.
"""
operation: NotificationUpdateOperation!
}
"""
Inputs for a revision-guarded replacement update.
"""
input UpdateSavedViewInput {
"""
Identity of the definition to update.
"""
id: ID!
"""
Revision that must still match when the update commits.
"""
expectedRevision: Int!
"""
Replacement display name; omission preserves the current name.
"""
name: String
"""
Complete replacement configuration; omission preserves current filters.
"""
config: JSON
"""
Explicit sharing change; omission preserves the existing share.
"""
sharing: SavedViewSharingInput
}
"""
One item to mark done.
"""
input WorkFeedDoneItemInput {
"""
The item's id.
"""
id: ID!
"""
The entry's `revision` the caller observed. Reasons newer than it
stay active. Omit to acknowledge everything current.
"""
revision: String
}
"""
An item placed in one feed: where it sits, why, and what marking it done
acknowledges.
"""
type WorkFeedEntry {
"""
The item.
"""
item: WorkFeedItem!
"""
Where the entry sits, in RFC 3339: the later of the item's attention
and own-work times in this feed.
"""
sortAt: String!
"""
The viewer's newest own work counted by this feed, in RFC 3339;
always absent in attention mode.
"""
touchedAt: String
"""
Opaque token of the attention this entry shows; send it with done so
notifications that arrive later stay active.
"""
revision: String!
"""
Why the entry is presented the way it is.
"""
primaryReason: WorkFeedPrimaryReason!
"""
Index into the item's stacks of the stack the entry presents and
opens, when its primary reason is attention.
"""
primaryStackIndex: Int
}
"""
An item that no longer belongs in the subscribed feed: done, filtered out
or inaccessible. The entity itself is not necessarily deleted.
"""
type WorkFeedEntryRemoved {
"""
The removed item's id.
"""
itemId: ID!
}
"""
An item that belongs in the subscribed feed, with its current content and
placement. Insert it, or move it to its new `sortAt`.
"""
type WorkFeedEntryUpserted {
"""
The entry.
"""
entry: WorkFeedEntry!
}
"""
Page request for the viewer's work feed.
"""
input WorkFeedInput {
"""
Which items the feed shows.
"""
scope: WorkFeedScopeInput
"""
Only items in this state: `UNSEEN` or `SEEN`. Subscriptions and undo
place items in every state, so an item seen while it is shown stays
until the page is fetched again.
"""
state: WorkFeedItemState
"""
Page size; defaults to 50, capped at 100.
"""
limit: Int
"""
Opaque cursor from the previous page's `nextCursor`; absent for the
first page. Send it with the same scope and state.
"""
cursor: String
}
"""
Changes may have been missed: refetch the feed.
"""
type WorkFeedInvalidated {
"""
Always true.
"""
refresh: Boolean!
}
"""
One context the viewer can return to or acknowledge: an entity, a
channel thread, or a channel's activity outside its threads. Items are
shared across feeds; placement and primary reason live on each entry.
"""
type WorkFeedItem {
"""
Stable per-viewer item id: `<entity type>:<entity id>`.
"""
id: ID!
"""
The entity the item is about; a channel thread's entity is its root
message.
"""
entity: GraphqlSoupEntity!
"""
The item's state for the viewer.
"""
state: WorkFeedItemState!
"""
When the newest active notification in the item's scope was created,
in RFC 3339; absent when the item has no outstanding attention.
"""
attentionAt: String
"""
How many of the item's active notifications are unseen.
"""
unseenCount: Int!
"""
The item's active notifications grouped for presentation, newest
stack first.
"""
stacks: [WorkFeedStack!]!
}
"""
An item's state for its viewer.
"""
enum WorkFeedItemState {
"""
At least one active reason is unseen.
"""
UNSEEN
"""
Every active reason has been seen.
"""
SEEN
"""
Every notification the viewer observed was completed.
"""
DONE
}
"""
The kinds of item a work feed can be narrowed to.
"""
enum WorkFeedItemType {
"""
Documents other than tasks.
"""
DOCUMENT
"""
Tasks.
"""
TASK
"""
AI chats.
"""
CHAT
"""
Projects (folders).
"""
PROJECT
"""
Task projects (initiatives).
"""
INITIATIVE
"""
Email threads.
"""
EMAIL
"""
Channel activity outside a dedicated thread item.
"""
CHANNEL
"""
One channel thread.
"""
CHANNEL_THREAD
"""
Calendar reminders.
"""
CALENDAR_EVENT
"""
GitHub pull requests.
"""
PULL_REQUEST
"""
Agent sessions.
"""
AGENT_SESSION
}
"""
Which reasons admit items to a work feed.
"""
enum WorkFeedMode {
"""
Outstanding attention plus the viewer's recent own work.
"""
WORK
"""
Outstanding attention only.
"""
ATTENTION
}
"""
One page of the viewer's work feed, newest first.
"""
type WorkFeedPage {
"""
The page's entries.
"""
entries: [WorkFeedEntry!]!
"""
Cursor for the next page; absent once the feed is exhausted.
"""
nextCursor: String
"""
Where this page's read stopped, the position `nextCursor` resumes
after; absent once the feed is exhausted. A filtered page can read
past its last entry, so a live change placed after that entry but not
after this position belongs to this page rather than a later one.
"""
nextPosition: WorkFeedPosition
}
"""
One change to a work feed's membership, placement or items.
"""
union WorkFeedPatch = WorkFeedEntryUpserted | WorkFeedEntryRemoved | WorkFeedInvalidated
"""
A place in the feed's order: newest `sortAt` first, then entity id
descending.
"""
type WorkFeedPosition {
"""
The sort time, RFC 3339.
"""
sortAt: String!
"""
The entity id that breaks ties at `sortAt`.
"""
entityId: String!
}
"""
Why an entry is presented the way it is in its feed.
"""
enum WorkFeedPrimaryReason {
"""
The viewer's own work is the newest reason: open the entity.
"""
OWN_WORK
"""
Incoming attention is the newest reason: present and open the
primary stack.
"""
ATTENTION
}
"""
Which items a work feed shows. Pages, subscriptions and undo for one feed
send the same scope.
"""
input WorkFeedScopeInput {
"""
Which reasons admit items. Defaults to `WORK`.
"""
mode: WorkFeedMode
"""
Item kinds to include; omitted or empty means every kind.
"""
types: [WorkFeedItemType!]
"""
Whether snippet documents are included. Defaults to false.
"""
includeSnippets: Boolean
}
"""
Notifications grouped the way they are presented, newest first. The
newest notification names the stack and is its navigation target.
"""
type WorkFeedStack {
"""
How the stack groups its notifications.
"""
kind: WorkFeedStackKind!
"""
The conversation thread the stack belongs to, when it is one: a
channel thread root, document comment thread or discussion thread.
"""
threadId: String
"""
When the stack's newest notification was created, in RFC 3339.
"""
latestAt: String!
"""
Whether any notification in the stack is unseen.
"""
unseen: Boolean!
"""
How many notifications the stack holds.
"""
count: Int!
"""
The stack's notifications, newest first. Defaults to 20, capped at
100; `count` is the full size.
"""
notifications(limit: Int): [GraphqlNotification!]!
}
"""
How one stack groups its notifications.
"""
enum WorkFeedStackKind {
"""
Replies, thread mentions and the absorbed root of one channel thread.
"""
CHANNEL_THREAD
"""
One root mention in a channel whose thread has no replies yet.
"""
CHANNEL_MENTION
"""
New root messages in a channel.
"""
CHANNEL_MESSAGES
"""
Reactions to the viewer's channel messages.
"""
CHANNEL_REACTIONS
"""
Several comments, replies or mentions in one document comment thread.
"""
COMMENT_THREAD
"""
A standalone mention in a document comment.
"""
COMMENT_MENTION
"""
Standalone root comments on a document.
"""
COMMENTS
"""
Mentions of a document in channels.
"""
DOCUMENT_MENTIONS
"""
One discussion thread on a project, company or contact.
"""
DISCUSSION
"""
Any other single event.
"""
EVENT
}
"""
Marks an element of a GraphQL schema as no longer supported.
"""
directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE
"""
Directs the executor to include this field or fragment only when the `if` argument is true.
"""
directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"""
Indicates that an Input Object is a OneOf Input Object (and thus requires exactly one of its field be provided)
"""
directive @oneOf on INPUT_OBJECT
"""
Directs the executor to skip this field or fragment when the `if` argument is true.
"""
directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"""
Provides a scalar specification URL for specifying the behavior of custom scalar types.
"""
directive @specifiedBy(url: String!) on SCALAR
schema {
query: SoupQueryRoot
mutation: CompleteMutationRoot
subscription: CompleteSubscriptionRoot
}