Skip to content

Query

Root query fields reachable with a workspace API key.

auditEventsAuditEventsList!

Lists audit events in a timestamp range, ordered newest first. Workspace admins see all events; other callers see a filtered view that omits workspace, billing, invitation and other members’ API key events, and shows notification rule events only for teams they own or administer. A page can be shorter than limit for a filtered caller, so paginate until nextToken is null.

  • betweenDateRange!

    Half-open timestamp range (from inclusive, to exclusive).

  • entityTypeString

    Filter by entity type name.

  • entityIdID

    Filter by entity id.

  • authorID

    Filter by author member id.

  • typeAuditEventType

    Filter by audit event type.

  • scopeTypeString

    Filter by scope type name.

  • scopeIdIn[ID!]

    Filter by scope ids.

  • nextTokenString

    Pagination cursor from a previous response.

  • limitInt

    Maximum number of items to return.

coverageOutlookCoverageOutlook!

Returns forward-looking team coverage for a calendar date range.

  • teamIdID!

    Team to compute coverage for.

  • betweenPlainDateRange!

    Inclusive calendar dates with a maximum span of 180 days. from must be no earlier than 7 UTC calendar days before today.

  • granularityCoverageOutlookGranularity

    Time bucket size for the returned periods. Defaults to day when omitted.

  • daysOfWeek[Int!]

    ISO weekdays to include (1=Monday through 7=Sunday). Defaults to workspace working days when omitted.

  • coverageMetricCoverageOutlookMetric

    Metric applied to each period’s raw coverage value. Defaults to membersAvailable when omitted.

eventCategoriesEventCategoriesList!

Lists event categories in the current workspace.

  • teamIdID

    Filter to a single team.

  • idIn[ID!]

    Filter to specific event category ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

eventCategoryEventCategory

Returns an event category by id.

  • idID!

    Event category id to fetch.

eventTypeEventType

Returns an event type by id.

  • idID!

    Event type id to fetch.

eventTypePoliciesEventTypePoliciesList!

Lists event type policies in the current workspace.

  • eventTypeIdIn[ID!]

    Filter to policies of specific event type ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

eventTypesEventTypesList!

Lists event types in the current workspace.

  • teamIdID

    Filter to a single team.

  • categoryIdID

    Filter to a single event category.

  • idIn[ID!]

    Filter to specific event type ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

groupEventGroupEvent

Returns a group event by id.

  • idID!

    Group event id to fetch.

groupEventsGroupEventsList!

Lists group events in an inclusive calendar date range. May fail with RESULT_TOO_LARGE; narrow the date range or filters.

  • betweenPlainDateRange!

    Inclusive calendar date range for event overlap.

  • memberIdIn[ID!]

    Filter to group events that apply to specific member ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

memberMember

Returns a member by id.

  • idID!

    Member id to fetch.

memberEventMemberEvent

Returns a member event by id.

  • idID!

    Member event id to fetch.

memberEventPolicyCheckMemberEventPolicyCheck!

Checks a booking against its event type’s policies without saving anything. For a new booking pass memberId and eventTypeId. For an edit pass eventId (and flag for a recurring event, as for updateMemberEvent); the member and event type then come from the stored event. Always pass the full proposed dates, time zone and recurrence, not only the changed fields. An edit is checked only when it changes the dates or the recurrence. The result is advisory: the write itself is checked again, and two bookings saved at the same time can both pass a minimum gap rule.

  • memberIdID

    Member the new booking is for. Required with eventTypeId when eventId is not set.

  • eventTypeIdID

    Event type of the new booking. Required with memberId when eventId is not set.

  • eventIdID

    Member event to edit: event id, series id, or virtual occurrence id depending on flag, as for updateMemberEvent. Do not combine with memberId or eventTypeId.

  • flagRecurrenceChangeFlag

    Recurrence change scope of the edit, as for updateMemberEvent. Required when eventId is a recurring series or occurrence.

  • startDateAWSDate!

    Inclusive start date of the proposed booking (YYYY-MM-DD). For a series, the start of the first occurrence.

  • endDateAWSDate!

    Inclusive end date of the proposed booking (YYYY-MM-DD). For a series, the end of the first occurrence.

  • timeZoneString!

    IANA time zone of the booking. Advance notice is counted from the current date in this time zone.

  • recurrenceRecurrenceInput

    Proposed recurrence. Omit or pass null for a single booking. Not allowed with flag this.

memberEventsMemberEventsList!

Lists member events in an inclusive calendar date range. Requires at least one of memberIdIn or eventTypeIdIn. May fail with RESULT_TOO_LARGE; narrow the date range or filters.

  • betweenPlainDateRange!

    Inclusive calendar date range for event overlap.

  • memberIdIn[ID!]

    Filter to specific member ids.

  • eventTypeIdIn[ID!]

    Filter to specific event type ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

membersMembersList!

Lists members in the current workspace.

  • idIn[ID!]

    Filter to specific member ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

notificationDispatchesNotificationDispatchesList!

Lists notification dispatch records, ordered newest first.

  • betweenDateRange

    Optional half-open timestamp range (from inclusive, to exclusive).

  • sourceTypeString

    Filter by source type name.

  • sourceIdID

    Filter by source id.

  • nextTokenString

    Pagination cursor from a previous response.

  • limitInt

    Maximum number of items to return.

teamTeam

Returns a team by id.

  • idID!

    Team id to fetch.

teamMembersTeamMembersList!

Lists team member links, optionally filtered by team or member.

  • teamIdID

    Filter to a single team.

  • memberIdID

    Filter to a single member.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

teamNotificationRuleTeamNotificationRule

Returns a team notification rule by id.

  • idID!

    Team notification rule id to fetch.

teamNotificationRuleEvalsTeamNotificationRuleEvalsList!

Lists evaluation runs for a team notification rule, ordered newest first.

  • ruleIdID!

    Rule id to list evaluations for.

  • betweenDateRange

    Optional half-open timestamp range (from inclusive, to exclusive).

  • nextTokenString

    Pagination cursor from a previous response.

  • limitInt

    Maximum number of items to return.

teamNotificationRulesTeamNotificationRulesList!

Lists team notification rules in the current workspace.

  • teamIdID

    Filter to a single team.

  • typeTeamNotificationRuleType

    Filter by rule type.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

teamsTeamsList!

Lists teams in the current workspace.

  • idIn[ID!]

    Filter to specific team ids.

  • limitInt

    Maximum number of items to return.

  • nextTokenString

    Pagination cursor from a previous response.

workspaceWorkspace

Returns the workspace for the current request context.