c.l.cladDocs

Workspace

Every teams, members, tags, widgets, SLA, and settings query and mutation.

Teams, members, tags, widgets, SLA policies, and workspace settings.

Queries

apiInfo

apiInfo: JSON

Public API metadata: version, schema hash, and server time.

autoResponseSettings

autoResponseSettings: AutoResponseSettings

members

members: [Member!]

All members of the authenticated organization.

node

node(id: ID!): Node

Fetch any node-capable object by its globally unique opaque id.

ArgumentTypeDescription
idID!Required.

nodes

nodes(ids: [ID!]!): [Node]!

Fetch up to 50 nodes by globally unique opaque ids (null for unknown/foreign ids).

ArgumentTypeDescription
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): Widget

A widget by id. Omit id to get (and lazily provision) the org's default widget.

ArgumentTypeDescription
idID

widgetForms

widgetForms: [WidgetForm!]

All widget intake forms for the organization.

widgets

widgets: [Widget!]

workspaceSettings

workspaceSettings: WorkspaceSettings

Mutations

addTeamMembers

addTeamMembers(profileIds: [ID!]!, teamId: ID!): TeamResult

Add org members to a team (skips profiles already on the team).

ArgumentTypeDescription
profileIds[ID!]!Opaque Profile ids of org members to add.
teamIdID!Required.

createTag

createTag(input: CreateTagInput!): TagResult

Create a workspace tag.

ArgumentTypeDescription
inputCreateTagInput!Required.

createTeam

createTeam(name: String!): TeamResult

Create a team.

ArgumentTypeDescription
nameString!Required.

createWidget

createWidget(name: String): WidgetResult

Create an additional web widget (the org's first widget is the default).

ArgumentTypeDescription
nameString

createWidgetForm

createWidgetForm(input: CreateWidgetFormInput!): WidgetFormResult

Create a widget intake form (org-unique slug).

ArgumentTypeDescription
inputCreateWidgetFormInput!Required.

deleteTag

deleteTag(id: ID!): DeleteTagResult

Delete a tag and strip it from every issue and account.

ArgumentTypeDescription
idID!Required.

deleteTeam

deleteTeam(teamId: ID!): DeleteTeamResult

Delete a team (memberships and issue assignments cascade).

ArgumentTypeDescription
teamIdID!Required.

deleteWidget

deleteWidget(id: ID!): DeleteWidgetResult

Delete a web widget. Default resolution falls back to the earliest remaining widget.

ArgumentTypeDescription
idID!Required.

deleteWidgetForm

deleteWidgetForm(id: ID!): DeleteWidgetFormResult

Delete a widget intake form.

ArgumentTypeDescription
idID!Required.

removeTeamMember

removeTeamMember(profileId: ID!, teamId: ID!): TeamResult

Remove a member from a team.

ArgumentTypeDescription
profileIdID!Opaque Profile id of the member to remove.
teamIdID!Required.

renameTeam

renameTeam(name: String!, teamId: ID!): TeamResult

Rename a team.

ArgumentTypeDescription
nameString!Required.
teamIdID!Required.

updateAutoResponseSettings

updateAutoResponseSettings(input: UpdateAutoResponseInput!): AutoResponseResult
ArgumentTypeDescription
inputUpdateAutoResponseInput!Required.

updateTag

updateTag(input: UpdateTagInput!): TagResult

Rename/recolor a tag. Renames cascade to every issue and account carrying it.

ArgumentTypeDescription
inputUpdateTagInput!Required.

updateWidget

updateWidget(input: UpdateWidgetInput!): WidgetResult
ArgumentTypeDescription
inputUpdateWidgetInput!Required.

updateWidgetForm

updateWidgetForm(input: UpdateWidgetFormInput!): WidgetFormResult

Update a widget intake form (name, slug, fields, enabled).

ArgumentTypeDescription
inputUpdateWidgetFormInput!Required.

updateWorkspaceSettings

updateWorkspaceSettings(input: UpdateWorkspaceSettingsInput!): WorkspaceSettingsResult
ArgumentTypeDescription
inputUpdateWorkspaceSettingsInput!Required.