Workspace
Every teams, members, tags, widgets, SLA, and settings query and mutation.
Teams, members, tags, widgets, SLA policies, and workspace settings.
Queries
apiInfo
apiInfo: JSONPublic API metadata: version, schema hash, and server time.
autoResponseSettings
autoResponseSettings: AutoResponseSettingsmembers
members: [Member!]All members of the authenticated organization.
node
node(id: ID!): NodeFetch any node-capable object by its globally unique opaque id.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
nodes
nodes(ids: [ID!]!): [Node]!Fetch up to 50 nodes by globally unique opaque ids (null for unknown/foreign ids).
| Argument | Type | Description |
|---|---|---|
ids | [ID!]! | Required. |
slaPolicies
slaPolicies: [SlaPolicy!]The org's SLA policies with version history (evaluation order).
supportHoursSchedules
supportHoursSchedules: [SupportHoursSchedule!]The org's support-hours schedules (with intervals and holidays).
tags
tags: [Tag!]All workspace tags, alphabetical.
teams
teams: [Team!]All teams in the organization, each with its members.
widget
widget(id: ID): WidgetA widget by id. Omit id to get (and lazily provision) the org's default widget.
| Argument | Type | Description |
|---|---|---|
id | ID |
widgetForms
widgetForms: [WidgetForm!]All widget intake forms for the organization.
widgets
widgets: [Widget!]workspaceSettings
workspaceSettings: WorkspaceSettingsMutations
addTeamMembers
addTeamMembers(profileIds: [ID!]!, teamId: ID!): TeamResultAdd org members to a team (skips profiles already on the team).
| Argument | Type | Description |
|---|---|---|
profileIds | [ID!]! | Opaque Profile ids of org members to add. |
teamId | ID! | Required. |
createTag
createTag(input: CreateTagInput!): TagResultCreate a workspace tag.
| Argument | Type | Description |
|---|---|---|
input | CreateTagInput! | Required. |
createTeam
createTeam(name: String!): TeamResultCreate a team.
| Argument | Type | Description |
|---|---|---|
name | String! | Required. |
createWidget
createWidget(name: String): WidgetResultCreate an additional web widget (the org's first widget is the default).
| Argument | Type | Description |
|---|---|---|
name | String |
createWidgetForm
createWidgetForm(input: CreateWidgetFormInput!): WidgetFormResultCreate a widget intake form (org-unique slug).
| Argument | Type | Description |
|---|---|---|
input | CreateWidgetFormInput! | Required. |
deleteTag
deleteTag(id: ID!): DeleteTagResultDelete a tag and strip it from every issue and account.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
deleteTeam
deleteTeam(teamId: ID!): DeleteTeamResultDelete a team (memberships and issue assignments cascade).
| Argument | Type | Description |
|---|---|---|
teamId | ID! | Required. |
deleteWidget
deleteWidget(id: ID!): DeleteWidgetResultDelete a web widget. Default resolution falls back to the earliest remaining widget.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
deleteWidgetForm
deleteWidgetForm(id: ID!): DeleteWidgetFormResultDelete a widget intake form.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
removeTeamMember
removeTeamMember(profileId: ID!, teamId: ID!): TeamResultRemove a member from a team.
| Argument | Type | Description |
|---|---|---|
profileId | ID! | Opaque Profile id of the member to remove. |
teamId | ID! | Required. |
renameTeam
renameTeam(name: String!, teamId: ID!): TeamResultRename a team.
| Argument | Type | Description |
|---|---|---|
name | String! | Required. |
teamId | ID! | Required. |
updateAutoResponseSettings
updateAutoResponseSettings(input: UpdateAutoResponseInput!): AutoResponseResult| Argument | Type | Description |
|---|---|---|
input | UpdateAutoResponseInput! | Required. |
updateTag
updateTag(input: UpdateTagInput!): TagResultRename/recolor a tag. Renames cascade to every issue and account carrying it.
| Argument | Type | Description |
|---|---|---|
input | UpdateTagInput! | Required. |
updateWidget
updateWidget(input: UpdateWidgetInput!): WidgetResult| Argument | Type | Description |
|---|---|---|
input | UpdateWidgetInput! | Required. |
updateWidgetForm
updateWidgetForm(input: UpdateWidgetFormInput!): WidgetFormResultUpdate a widget intake form (name, slug, fields, enabled).
| Argument | Type | Description |
|---|---|---|
input | UpdateWidgetFormInput! | Required. |
updateWorkspaceSettings
updateWorkspaceSettings(input: UpdateWorkspaceSettingsInput!): WorkspaceSettingsResult| Argument | Type | Description |
|---|---|---|
input | UpdateWorkspaceSettingsInput! | Required. |