Schema Types

Table of Contents

Query
Mutation
Objects
Inputs
Scalars
- Boolean
- DateTime
- Email
- Float
- String
- UUID

Query

Field	Type	Description
syncBootstrap	SyncResponse!	Fetches all data for the user.
databaseVersion	Float!
sinceId	Float!
syncUpdates	SyncResponse!	Fetches all data for the user.
sinceId	Float!
apiKeys	[ApiKey!]!	Fetches all api keys.
comments	[Comment!]!	Fetches all comments.
comment	Comment!	Fetches a specific comment.
id	String!
integrations	[Integration!]!	Fetches all integrations.
integration	Integration!	Fetches a specific integration.
id	String!
integrationResources	[IntegrationResource!]!	Fetches all integrations resources (e.g. linked GitHub pull requests for issues).
integrationResource	IntegrationResource!	Fetches a specific integration resource (e.g. linked GitHub pull requests for an issue).
id	String!
issueLabels	[IssueLabel!]!	Fetches all issue labels.
issueLabel	IssueLabel!	Fetches a specific issue label.
id	String!
issues	[Issue!]!	Fetches all issues.
issue	Issue!	Fetches a specific issue.
id	String!
notifications	[Notification!]!	Fetches all notifications.
notification	UserSettings!	Fetches the users settings.
organizations	[Organization!]!	Fetches the users organization.
organization	Organization!	Fetches the users organization.
id	String!
projects	[Project!]!	Fetches all projects.
project	Project!	Fetches a specific project.
id	String!
projectStates	[ProjectState!]!	Fetches all project workflow states.
projectState	ProjectState!	Fetches a specific project workflow state.
id	String!
users	[User!]!	Fetches all users.
user	User!	Fetches a specific user.
id	String!

Mutation

Field	Type	Description
apiKeyCreate	ApiKeyPayload!	Creates a new api key.
input	ApiKeyCreateInput!	The api key object to create.
apiKeyArchive	ArchivePayload!	Archives an api key.
id	String!	The identifier of the api key to archive.
commentCreate	CommentPayload!	Creates a new comment.
input	CommentCreateInput!	The comment object to create.
commentUpdate	CommentPayload!	Updates a comment.
input	CommentUpdateInput!	A partial comment object to update the issue with.
id	String!	The identifier of the comment to update.
commentArchive	ArchivePayload!	Archives a comment.
id	String!	The identifier of the comment to archive.
imageUpload	ImageUploadPayload!	XHR request payload to upload an image directly to Google Cloud Storage
contentType	String!	Upload mime-type
filename	String!	Filename of the uploaded file
integrationGithubConnect	IntegrationPayload!	Connects with Github App.
installationId	String!	The Github data to connect with.
integrationSlack	IntegrationPayload!	Save regular Slack integration.
redirectUri	String!	The Slack OAuth redirect URI.
code	String!	The Slack OAuth code.
integrationSlackPost	IntegrationPayload!	Save Slack webhook integration.
redirectUri	String!	The Slack OAuth redirect URI.
projectId	String!	Integration's associated project.
code	String!	The Slack OAuth code.
integrationArchive	ArchivePayload!	Archives an integration.
id	String!	The identifier of the integration to archive.
integrationResourceArchive	ArchivePayload!	Archives an integration resource.
id	String!	The identifier of the integration resource to archive.
issueLabelCreate	IssueLabelPayload!	Creates a new issue label.
input	IssueLabelCreateInput!	The issue label object to create.
issueLabelArchive	ArchivePayload!	Archives an issue label.
id	String!	The identifier of the issue label to archive.
issueCreate	IssuePayload!	Creates a new issue.
input	IssueCreateInput!	The issue object to create.
issueUpdate	IssuePayload!	Updates an issue.
input	IssueUpdateInput!	A partial issue object to update the issue with.
id	String!	The identifier of the issue to update.
issueClose	IssuePayload!	Closes an issue by moving it into the first completed state.
id	String!	The identifier of the issue to close.
issueArchive	ArchivePayload!	Archives an issue.
id	String!	The identifier of the issue to archive.
notificationUpdate	NotificationPayload!	Updates a notification.
input	NotificationUpdateInput!	A partial notification object to update the issue with.
id	String!	The identifier of the notification to update.
notificationArchive	ArchivePayload!	Archives a notification.
id	String!	The identifier of the notification to archive.
organizationCreate	OrganizationPayload!	Creates a new organization.
input	CreateOrganizationInput!	The organization object to create.
organizationUpdate	OrganizationPayload!	Updates the users organization.
input	UpdateOrganizationInput!	A partial organization object to update the organization with.
projectCreate	ProjectPayload!	Creates a new project.
input	ProjectCreateInput!	The project object to create.
projectUpdate	ProjectPayload!	Updates a project.
input	ProjectUpdateInput!	A partial project object to update the project with.
id	String!	The identifier of the project to update
projectArchive	ArchivePayload!	Archives a project.
id	String!	The identifier of the project to archive
projectStateCreate	ProjectStatePayload!	Creates a new project workflow state.
input	ProjectStateCreateInput!	The project workflow state object to create.
projectStateUpdate	ProjectStatePayload!	Updates a project workflow state.
input	ProjectStateUpdateInput!	A partial project workflow state object to update.
id	String!	The identifier of the project workflow state to update.
projectStateArchive	ArchivePayload!	Archives a project workflow state. Only states with issues that have been archived can be archived themselves.
id	String!	The identifier of the project workflow state to archive.
pushSubscriptionCreate	PushSubscriptionPayload!	Creates a push subscription.
input	PushSubscriptionCreateInput!	The subscription to create.
pushSubscriptionArchive	PushSubscriptionPayload!	Archives a PushSubscription.
id	String!	The identifier of the PushSubscription to archive
userAccountGoogleAuth	UserGoogleAuthPayload!	Second step of Google's OAuth flow
code	String!	Code returned from Google's OAuth flow
userCreate	UserPayload!	Creates a new user.
input	CreateUserInput!	The user object to create.
userUpdate	UserPayload!	Updates a user.
input	UpdateUserInput!	A partial user object to update the user with.
id	String!	The identifier of the user to update.
userArchive	ArchivePayload!	Archives a user.
id	String!	The identifier of the user to archive.
userSettingsUpdate	UserSettingsPayload!	Updates user settings.
input	UserSettingsUpdateInput!	A partial notification object to update the settings with.
id	String!	The identifier of the userSettings to update

Objects

ApiKey

An API key

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
label	String!	Key label.

ApiKeyPayload

Field	Argument	Type	Description
userError		[String!]!
apiKey		ApiKey!

ArchivePayload

Field	Argument	Type	Description
userError		[String!]!

BackendEntity

The base class of a backend entity object. Not to be used directly.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.

ClientEntity

The base class of a model object. Not to be used directly

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.

Comment

An issue comment

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
body	String!	Comment content
issue	Issue!	The issue that the comment is associated with.
user	User!	The user who wrote the comment

CommentPayload

Field	Argument	Type	Description
userError		[String!]!
comment		Comment!

GitHubCommitPayload

GitHub's commit data

Field	Argument	Type	Description
id		String!
message		String!
timestamp		String!
url		String!
added		[String!]!
removed		[String!]!
modified		[String!]!

GitHubPullRequestPayload

GitHub's pull request data

Field	Argument	Type	Description
status		String!
number		Float!
url		String!
id		String!
title		String!
userId		String!
userLogin		String!
createdAt		String!
updatedAt		String!
closedAt		String!
mergedAt		String!

ImageUploadPayload

Field	Argument	Type	Description
userError		[String!]!
uploadFile		UploadFile

Integration

An integration to external service

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
service	String!	The integration's type.
serviceId	String	The external service ID.
organization	Organization!	The organization that the integration is associated with.
project	Project	The project that the integration is associated with.
creator	User!	The user who added the integration
settings	IntegrationSettings!	Settings related to the integration.

IntegrationPayload

Field	Argument	Type	Description
userError		[String!]!
integration		Integration

IntegrationResource

An integration resource from external service

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
resourceType	String!	The integration's type.
resourceId	String!	The external service resource ID.
integration	Integration!	The integration that the resource is associated with.
issue	Issue!	The issue that the resource is associated with.
data	IntegrationResourceData!	Detailed information about the external resource.

IntegrationResourceData

Integration resource's payload

Field	Argument	Type	Description
githubPullRequest		GitHubPullRequestPayload
githubCommit		GitHubCommitPayload

IntegrationSettings

Integration resource's payload

Field	Argument	Type	Description
slackPost		SlackPostSettings

Issue

An issue.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
number	Float!	The issue's unique number.
title	String!	The issue's title.
description	String	The issue's description in markdown.
comments	[Comment!]!	Comments associated with the issue
labels	[IssueLabel!]!	Labels associated with the issue.
project	Project!	The project that the issue is associated with.
creator	User!	The user who created the issue.
assignee	User	The user to whom the issue is assigned to.
subscribers	[User!]!	Users who are subscribed to the issue.
state	ProjectState!	The workflow state that the issue is associated with.
boardOrder	Float	The order of the item in its column on the board.
startedAt	DateTime	The time at which the issue was moved into started state.
completedAt	DateTime	The time at which the issue was moved into completed state.
canceledAt	DateTime	The time at which the issue was moved into canceled state.

IssueLabel

Issue labels.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
name	String!	The issue label's name.
description	String	The issue label's description.
color	String!	The label color.
project	Project!	The parent project in which this label belongs to.
creator	User	The user who created the label.

IssueLabelPayload

Field	Argument	Type	Description
userError		[String!]!
issueLabel		IssueLabel!

IssuePayload

Field	Argument	Type	Description
userError		[String!]!
issue		Issue

Notification

A user notification

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
type	String!	Notification type
user	User!	The user to whom this notification was targeted for.
issue	Issue!	The issue that the notification is associated with.
project	Project!	The project which the notification is associated with
readAt	DateTime	The time at when the user marked it as read.

NotificationPayload

Field	Argument	Type	Description
userError		[String!]!
notification		Notification!

Organization

Organizations contain user accounts and projects.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
name	String!	The organizations name.
pictureUrl	String	The organizations picture.
projects	[Project!]!	Projects associated with the organization.
users	[User!]!	Users associated with the organization.

OrganizationPayload

Field	Argument	Type	Description
userError		[String!]!
organization		Organization

Project

A project that contains issues.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
name	String!	The project's name.
key	String!	The project's unique key.
description	String	The project's description.
issues	[Issue!]!	Issues associated with the project
keys	[Issue!]!	Keys associated with the project
issueLabels	[IssueLabel!]!	Issue labels associated with the project.
states	[ProjectState!]!	Issues belonging in this workflow state
organization	Organization!	The organization that the project is associated with.

ProjectPayload

Field	Argument	Type	Description
userError		[String!]!
project		Project

ProjectState

Individual state in an issue workflow.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
name	String!	The state's name.
emoji	String	The state's emoji.
description	String	Information about the state.
position	Float!	Position of the state in the project flow.
type	String!	State type.
issues	[Issue!]!	Issues belonging in this workflow state
project	Project!	The parent project in which this state belongs to.

ProjectStatePayload

Field	Argument	Type	Description
userError		[String!]!
projectState		ProjectState!

PushSubscription

A user's push subscription.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.

PushSubscriptionPayload

Field	Argument	Type	Description
userError		[String!]!

SlackPostSettings

Field	Argument	Type	Description
channel		String!
channelId		String!
configurationUrl		String!

SyncResponse

A transport model for sync responses

Field	Type	Description
type	String!	The type of the sync response
data	String!	The serialized data associated with the sync response
lastSyncId	Float!	The last id covered by the response
databaseVersion	Float!	The version of the database. Increased by 1 for each migration run on the database

UploadFile

Object representing Google Cloud upload policy

Field	Argument	Type	Description
filename		String!
contentType		String!
uploadUrl		String!
assetUrl		String!

User

A user.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
name	String!	The user's full name.
displayName	String!	The user's display (nick) name.
email	Email!	The user's email address.
avatarUrl	String!	An URL to the user's avatar image
createdIssues	[Issue!]!	Issues created by the user.
assignedIssues	[Issue!]!	Issues assigned to the user.
notifications	[Notification!]!	Notifications assigned to the user.
pushSubscriptions	[PushSubscription!]!	Push subscriptions of the user.
apiKeys	[ApiKey!]!	Developer API keys of the user.
organization	Organization!	The organization that the user is associated with.
settings	UserSettings!	The settings of the user

UserAccount

A user account.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
name	String!	The user's name.
email	Email!	The user's email address.
user	User!	The user that this user account is associated with

UserGoogleAuthPayload

Field	Argument	Type	Description
token		String
userId		String

UserPayload

Field	Argument	Type	Description
userError		[String!]!
user		User

UserSettings

The settings of a user.

Field	Type	Description
id	UUID!	The models identifier.
createdAt	DateTime!	The time at which the model was created.
updatedAt	DateTime!	The time at which the model was updated.
archivedAt	DateTime	The time at which the model was archived.
user	User!	The user to whom this notification was targeted for.
sidebarCollapsed	Boolean!	Whether the navigation sidebar is collapsed.

UserSettingsPayload

Field	Argument	Type	Description
userError		[String!]!
userSettings		UserSettings!	The users settings.

Inputs

ApiKeyCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
label	String!	The API key label.
key	String!	The API key value (format: /^[a-zA-Z0-9]{40}$/).

CommentCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
body	String!	The comment content.
issueId	String!	The issue to associate the comment with.

CommentUpdateInput

Field		Type	Description
body		String!	The comment content.

CreateOrganizationInput

Field		Type	Description
id		String	The identifier. If none is provided, the backend will generate one
name		String!	The groups name.

CreateUserInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
name	String!	The users name.
displayName	String!	The users display name.
email	String!	The users email address.
avatarUrl	String	The users avatar image URL.
organizationId	String	The organization associated with the user.

IssueCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
title	String!	The issue's title.
description	String	The issue's description.
assigneeId	String	The id of the user to assign the issue to.
subscriberIds	[String!]	The ids of the users subscribing to this ticket.
labelIds	[String!]	The ids of the issue labels associated with this ticket.
projectId	String!	The project to associate the issue with.
stateId	String	The project state which the issue is assigned.
boardOrder	Float!	The order of the item in its column on the board.

IssueLabelCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
name	String!	The issue label's name.
description	String	The issue label's description.
color	String	The issue label's color.
projectId	String!	The project to associate the issue label with.

IssueUpdateInput

Field	Type	Description
title	String	The issue's title.
description	String	The issues description.
assigneeId	String	The id of the user to assign the issue to.
subscriberIds	[String!]	The ids of the users subscribing to this ticket.
labelIds	[String!]	The ids of the issue labels associated with this ticket.
projectId	String	The project to associate the issue with.
stateId	String	The project state which the issue is assigned.
boardOrder	Float	The order of the item in its column on the board.

NotificationUpdateInput

Field		Type	Description
readAt		DateTime	The time when notification was marked as read.

ProjectCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
name	String!	The name of the project.
description	String	The description of the project.
key	String	The key of the project. If not given, a key will be generated based on the name of the project.
organizationId	String	The organization associated with the project.

ProjectStateCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
name	String!	The name of the workflow state.
emoji	String	The name of the workflow state.
description	String	The description of the workflow state.
projectId	String!	The project to associate the workflow state with.

ProjectStateUpdateInput

Field	Type	Description
name	String!	The name of the workflow state.
emoji	String	The name of the workflow state.
description	String	The description of the workflow state.

ProjectUpdateInput

Field	Type	Description
name	String	The name of the project.
description	String	The description of the project.
key	String	The key of the project.

PushSubscriptionCreateInput

Field	Type	Description
id	String	The identifier. If none is provided, the backend will generate one
userId	String!	The user id of the subscription
data	String!	The data of the subscription in stringified JSON format

UpdateOrganizationInput

Field		Type	Description
name		String!	The groups name.

UpdateUserInput

Field	Type	Description
name	String	The users name.
displayName	String	The users display name.
email	String	The users email address.
avatarUrl	String	The users avatar image URL.
organizationId	String	The organization associated with the user.

UserSettingsUpdateInput

Field		Type	Description
settings		String	The user's settings

Scalars

Boolean

The Boolean scalar type represents true or false.

DateTime

The DateTime scalar type represents date time strings complying to ISO-8601.

Email

The Email scalar type represents E-Mail addresses compliant to RFC 822.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

UUID

The UUID scalar type represents a UUID.

FilesExpand file tree

schema.md

Latest commit

History