Objects - Charter

Field	Type	Description
`first`	`integer`	How many results to return. Linear returns 50 by default. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`, to fetch the next page.
`filter`	IssueFilter	Narrow the issues returned. Conditions combine with AND.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’. Linear sorts by ‘updatedAt’ by default.
`includeArchived`	`boolean`	Include archived issues in the results.

IssueFilter

A filter over issues. Conditions on the same object combine with AND.

Field	Type	Description
`id`	IdComparator	Comparator for the identifier.
`number`	NumberComparator	Comparator for the issues number.
`title`	StringComparator	Comparator for the issues title.
`description`	NullableStringComparator	Filter by issue description.
`priority`	NullableNumberComparator	Comparator for the issues priority. 0 = No priority, 1 = Urgent, 2 = High, 3 = Medium, 4 = Low.
`estimate`	EstimateComparator	Filter by the issue’s estimate.
`dueDate`	NullableTimelessDateComparator	Filter by the issue’s due date.
`createdAt`	DateComparator	Filter by when the issue was created.
`updatedAt`	DateComparator	Filter by when the issue was last updated.
`startedAt`	NullableDateComparator	Comparator for the issues started at date.
`completedAt`	NullableDateComparator	Filter by when the issue was completed.
`canceledAt`	NullableDateComparator	Filter by when the issue was canceled.
`triagedAt`	NullableDateComparator	Comparator for the issues triaged at date.
`archivedAt`	NullableDateComparator	Filter by when the issue was archived.
`snoozedUntilAt`	NullableDateComparator	Comparator for the issues snoozed until date.
`addedToCycleAt`	NullableDateComparator	Comparator for the issues added to cycle at date.
`addedToCyclePeriod`	CyclePeriodComparator	Comparator for the period when issue was added to a cycle.
`autoArchivedAt`	NullableDateComparator	Comparator for the issues auto archived at date.
`autoClosedAt`	NullableDateComparator	Comparator for the issues auto closed at date.
`slaBreachesAt`	NullableDateComparator	Comparator for the issue’s SLA breach date.
`slaStatus`	SlaStatusComparator	Comparator for the issues sla status.
`customerCount`	NumberComparator	Count of customers.
`customerImportantCount`	NumberComparator	Count of important customers.
`state`	WorkflowStateFilter	Filters that the issues state must satisfy.
`assignee`	NullableUserFilter	Filter by the issue’s assignee.
`creator`	NullableUserFilter	Filter by who created the issue.
`delegate`	NullableUserFilter	Filter by the agent the issue is delegated to.
`snoozedBy`	NullableUserFilter	Filters that the issues snoozer must satisfy.
`team`	TeamFilter	Filters that the issues team must satisfy.
`labels`	IssueLabelCollectionFilter	Filters that issue labels must satisfy.
`project`	NullableProjectFilter	Filters that the issues project must satisfy.
`projectMilestone`	NullableProjectMilestoneFilter	Filters that the issues project milestone must satisfy.
`cycle`	NullableCycleFilter	Filters that the issues cycle must satisfy.
`lastAppliedTemplate`	NullableTemplateFilter	Filters that the last applied template must satisfy.
`recurringIssueTemplate`	NullableTemplateFilter	[ALPHA] Filters that the recurring issue template must satisfy.
`sourceMetadata`	SourceMetadataComparator	Filters that the source must satisfy.
`hasBlockedByRelations`	RelationExistsComparator	Comparator for filtering issues which are blocked.
`hasBlockingRelations`	RelationExistsComparator	Comparator for filtering issues which are blocking.
`hasDuplicateRelations`	RelationExistsComparator	Comparator for filtering issues which are duplicates.
`hasRelatedRelations`	RelationExistsComparator	Comparator for filtering issues with relations.
`hasSharedUsers`	RelationExistsComparator	Comparator for filtering issues which have been shared with users outside of the team.

NullableNumberComparator

A numeric comparator for a field that may be null.

Field	Type	Description
`eq`	`number`	Equals the given value.
`neq`	`number`	Does not equal the given value.
`lt`	`number`	Is less than the given value.
`lte`	`number`	Is less than or equal to the given value.
`gt`	`number`	Is greater than the given value.
`gte`	`number`	Is greater than or equal to the given value.
`in_`	`number`[]	Is one of the given values.
`nin`	`number`[]	Is not one of the given values.
`null`	`boolean`	True to match only where the field is null, false where it is set.

EstimateComparator

Comparators for an issue estimate.

Field	Type	Description
`eq`	`number`	Equals the given value.
`neq`	`number`	Does not equal the given value.
`lt`	`number`	Is less than the given value.
`lte`	`number`	Is less than or equal to the given value.
`gt`	`number`	Is greater than the given value.
`gte`	`number`	Is greater than or equal to the given value.
`in_`	`number`[]	Is one of the given values.
`nin`	`number`[]	Is not one of the given values.
`null`	`boolean`	True to match only where the estimate is unset.
`and_`	NullableNumberComparator[]	Every comparator in this list must match.
`or_`	NullableNumberComparator[]	At least one comparator in this list must match.

NullableTimelessDateComparator

Comparators for a calendar date that may be null.

Field	Type	Description
`eq`	`string`	Equals the given date.
`neq`	`string`	Does not equal the given date.
`lt`	`string`	Is before the given date.
`lte`	`string`	Is at or before the given date.
`gt`	`string`	Is after the given date.
`gte`	`string`	Is at or after the given date.
`in_`	`string`[]	Is one of the given dates.
`nin`	`string`[]	Is not one of the given dates.
`null`	`boolean`	True to match only where the field is null, false where it is set.

CyclePeriodComparator

Comparators for which cycle period something falls in.

Field	Type	Description
`eq`	CyclePeriod	Equals the given period.
`neq`	CyclePeriod	Does not equal the given period.
`in_`	CyclePeriod[]	Is one of the given periods.
`nin`	CyclePeriod[]	Is not one of the given periods.
`null`	`boolean`	True to match only where there is no such period.

SlaStatusComparator

Comparators for an issue’s SLA status.

Field	Type	Description
`eq`	SlaStatus	Equals the given status.
`neq`	SlaStatus	Does not equal the given status.
`in_`	SlaStatus[]	Is one of the given statuses.
`nin`	SlaStatus[]	Is not one of the given statuses.
`null`	`boolean`	True to match only where no SLA applies.

NullableUserFilter

UserFilter that can also match an unset relation.

Field	Type	Description
`id`	IdComparator	Filter by user UUID.
`name`	StringComparator	Filter by name.
`displayName`	StringComparator	Filter by display name.
`email`	StringComparator	Filter by email address.

IssueLabelCollectionFilter

IssueLabelFilter plus collection operators.

Field	Type	Description
`id`	IdComparator	Filter by label UUID.
`name`	StringComparator	Filter by label name.

NullableProjectFilter

ProjectFilter that can also match an unset relation.

Field	Type	Description
`id`	IdComparator	Filter by project UUID.
`name`	StringComparator	Filter by project name.
`slugId`	StringComparator	Filter by the project’s slug.

RelationExistsComparator

Whether a relationship exists at all.

Field	Type	Description
`eq`	`boolean`	True to match where the relation exists.
`neq`	`boolean`	True to match where the relation does not exist.

NullableProjectMilestoneFilter

ProjectMilestoneFilter that can also match an unset relation.

Field	Type	Description
`id`	IdComparator	Filter by milestone UUID.
`name`	StringComparator	Filter by name.

NullableCycleFilter

CycleFilter that can also match an unset relation.

Field	Type	Description
`id`	IdComparator	Filter by cycle UUID.
`name`	StringComparator	Comparator for the cycle name.
`number`	NumberComparator	Filter by the cycle’s number.

NullableTemplateFilter

TemplateFilter that can also match an unset relation.

Field	Type	Description
`id`	IdComparator	Filter by template UUID.
`name`	StringComparator	Filter by name.
`type`	StringComparator	Comparator for the template’s type.

SourceMetadataComparator

Comparators for how an issue was created — an integration, intake, or not.

Field	Type	Description
`null`	`boolean`	When true, matches issues without an external source: issues with no source metadata and issues created through the API, an OAuth application, or a loop. When false, matches issues created by an integration or an intake source such as email.
`subType`	SubTypeComparator	Comparator for the sub type.
`workflowDefinitionId`	WorkflowDefinitionIdComparator	Comparator for the workflow definition that created the issue.

SubTypeComparator

Comparators for a source subtype string that may be null.

Field	Type	Description
`eq`	`string`	Equals the given value.
`neq`	`string`	Does not equal the given value.
`in_`	`string`[]	Is one of the given values.
`nin`	`string`[]	Is not one of the given values.
`null`	`boolean`	True to match only where the subtype is unset.

WorkflowDefinitionIdComparator

Comparators for the workflow definition that created an issue.

Field	Type	Description
`eq`	`string`	Equals the given UUID.
`neq`	`string`	Does not equal the given UUID.
`in_`	`string`[]	Is one of the given UUIDs.
`nin`	`string`[]	Is not one of the given UUIDs.
`null`	`boolean`	True to match only where no workflow definition applies.

IssueGetVariables

Variables for the issue query.

Field	Type	Description
`id` *	`string`	The issue’s UUID, or its human identifier such as ‘ENG-123’. Both are accepted here.

IssueCreateVariables

Variables for the issueCreate mutation.

Field	Type	Description
`input` *	IssueCreateInput	The issue to create.

IssueCreateInput

The input to issueCreate.

Field	Type	Description
`teamId` *	`string`	UUID of the team the issue belongs to. Required. Use `teams_list` to resolve a team key such as ‘ENG’ to its UUID.
`title` *	`string`	The issue title.
`description`	`string`	The issue description in markdown format.
`assigneeId`	`string`	The identifier of the user to assign the issue to. Use `users_list` to resolve a name.
`priority`	`integer`	The priority of the issue. 0 = No priority, 1 = Urgent, 2 = High, 3 = Medium, 4 = Low.
`stateId`	`string`	The team state of the issue. Use `workflow_states_list` to resolve a state name such as ‘In Progress’. Omit to use the team’s default.
`labelIds`	`string`[]	The identifiers of the issue labels associated with this ticket.
`projectId`	`string`	The project associated with the issue.
`projectMilestoneId`	`string`	The project milestone associated with the issue.
`cycleId`	`string`	The cycle associated with the issue.
`parentId`	`string`	The identifier of the parent issue, to create this as a sub-issue. Can be a UUID or issue identifier (e.g., ‘LIN-123’).
`subscriberIds`	`string`[]	The identifiers of the users subscribing to this ticket.
`estimate`	`integer`	The estimated complexity of the issue.
`dueDate`	`string`	The date at which the issue is due, as `YYYY-MM-DD`.
`sortOrder`	`number`	The position of the issue related to other issues.
`prioritySortOrder`	`number`	The position of the issue related to other issues, when ordered by priority.
`subIssueSortOrder`	`number`	The position of the issue in parent’s sub-issue list.
`preserveSortOrderOnCreate`	`boolean`	Whether the passed sort order should be preserved.
`delegateId`	`string`	The identifier of the agent user to delegate the issue to.
`slaType`	SlaDayCountType	The SLA day count type for the issue. Whether SLA should be business days only or calendar days (default).
`templateId`	`string`	The identifier of a template the issue should be created from. If other values are provided in the input, they will override template values.
`lastAppliedTemplateId`	`string`	The ID of the last template applied to the issue.
`useDefaultTemplate`	`boolean`	Whether to use the default template for the team. When set to true, the default template of this team based on user’s membership will be applied.
`sourceCommentId`	`string`	The comment the issue is created from.
`referenceCommentId`	`string`	The comment the issue is referencing.
`releaseIds`	`string`[]	The identifiers of the releases to associate with this issue.
`createdAt`	`string`	The time at which the issue was created (e.g. if importing from another system). Must be a time in the past. If none is provided, the backend will generate the time as now.
`completedAt`	`string`	The time at which the issue was completed (e.g. if importing from another system). Must be a time in the past and after createdAt. Cannot be provided with an incompatible workflow state.
`id`	`string`	The identifier in UUID v4 format. If none is provided, the backend will generate one.

IssueUpdateVariables

Variables for the issueUpdate mutation.

Field	Type	Description
`id` *	`string`	UUID or identifier of the issue to update.
`input` *	IssueUpdateInput	The fields to change.

IssueUpdateInput

The input to issueUpdate. Every field is optional.

Field	Type	Description
`title`	`string`	The issue title.
`description`	`string`	The issue description in markdown format. Replaces the existing one.
`assigneeId`	`string`	The identifier of the user to assign the issue to.
`priority`	`integer`	The priority of the issue. 0 = No priority, 1 = Urgent, 2 = High, 3 = Medium, 4 = Low.
`stateId`	`string`	The team state of the issue. This is how an issue is closed: move it to a state whose type is ‘completed’ or ‘canceled’.
`labelIds`	`string`[]	The complete set of label identifiers for the issue. This replaces the issue’s labels; use `added_label_ids` to add to them instead.
`addedLabelIds`	`string`[]	The identifiers of the issue labels to be added to this issue.
`removedLabelIds`	`string`[]	The identifiers of the issue labels to be removed from this issue.
`teamId`	`string`	The identifier of the team to move the issue to.
`projectId`	`string`	The project associated with the issue.
`projectMilestoneId`	`string`	The project milestone associated with the issue.
`cycleId`	`string`	The cycle associated with the issue.
`parentId`	`string`	The identifier of the parent issue.
`subscriberIds`	`string`[]	The identifiers of the users subscribing to this ticket.
`estimate`	`integer`	The estimated complexity of the issue.
`dueDate`	`string`	The date at which the issue is due, as `YYYY-MM-DD`.
`snoozedUntilAt`	`string`	The time until which the issue is snoozed, as an ISO 8601 timestamp.
`snoozedById`	`string`	The identifier of the user who snoozed the issue.
`delegateId`	`string`	The identifier of the agent user to delegate the issue to.
`trashed`	`boolean`	Whether the issue has been moved to the trash.
`sortOrder`	`number`	The position of the issue related to other issues.
`prioritySortOrder`	`number`	The position of the issue related to other issues, when ordered by priority.
`subIssueSortOrder`	`number`	The position of the issue in parent’s sub-issue list.
`slaType`	SlaDayCountType	The SLA day count type for the issue. Whether SLA should be business days only or calendar days (default).
`lastAppliedTemplateId`	`string`	The ID of the last template applied to the issue.
`releaseIds`	`string`[]	The identifiers of the releases associated with this issue.
`addedReleaseIds`	`string`[]	The identifiers of the releases to be added to this issue.
`removedReleaseIds`	`string`[]	The identifiers of the releases to be removed from this issue.
`autoClosedByParentClosing`	`boolean`	Whether the issue was automatically closed because its parent issue was closed.
`inheritsSharedAccess`	`boolean`	Whether this issue should inherit shared access from its parent issue.

IssueBatchUpdateVariables

Variables for the issueBatchUpdate mutation.

Field	Type	Description
`ids` *	`string`[]	The UUIDs of the issues to update. These must be UUIDs, not identifiers such as ‘ENG-123’. min 1 items
`input` *	IssueUpdateInput	The fields to change, applied to every issue in `ids`.

IssueDeleteVariables

Variables for the issueDelete mutation.

Field	Type	Description
`id` *	`string`	The issue’s UUID.
`permanentlyDelete`	`boolean`	Permanently delete the issue instead of moving it to the trash. This cannot be undone. Absent, the issue is trashed and can be restored.

IssueArchiveVariables

Variables for the issueArchive mutation.

Field	Type	Description
`id` *	`string`	The issue’s UUID.
`trash`	`boolean`	Send the issue to the trash as well as archiving it. Absent, it is archived and stays findable.

IssueUnarchiveVariables

Variables for the issueUnarchive mutation.

Field	Type	Description
`id` *	`string`	The issue’s UUID.

IssueLabelLinkVariables

Variables for issueAddLabel and issueRemoveLabel.

Field	Type	Description
`id` *	`string`	The issue’s UUID.
`labelId` *	`string`	The label’s UUID.

IssueSubscriptionVariables

Variables for issueSubscribe and issueUnsubscribe.

Field	Type	Description
`id` *	`string`	The issue’s UUID.
`userId`	`string`	The UUID of the user to subscribe. Omit both this and `user_email` to act on the authenticated user.
`userEmail`	`string`	The email address of the user to subscribe.

IssueRelationsListVariables

Variables for the issueRelations connection.

Field	Type	Description
`first`	`integer`	How many results to return. Linear returns 50 by default. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`, to fetch the next page.
`includeArchived`	`boolean`	Include relations on archived issues.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’.

IssueRelationGetVariables

Variables for the issueRelation query.

Field	Type	Description
`id` *	`string`	The relation’s UUID.

IssueRelationCreateVariables

Variables for the issueRelationCreate mutation.

Field	Type	Description
`input` *	IssueRelationCreateInput	The relation to create.

IssueRelationCreateInput

The input to issueRelationCreate.

Field	Type	Description
`issueId` *	`string`	The identifier of the issue that is related.
`relatedIssueId` *	`string`	The identifier of the related issue.
`type` *	IssueRelationType	The type of relation between the two issues.
`id`	`string`	The identifier in UUID v4 format. If none is provided, the backend will generate one.

IssueRelationUpdateVariables

Variables for the issueRelationUpdate mutation.

Field	Type	Description
`id` *	`string`	The relation’s UUID.
`input` *	IssueRelationUpdateInput	The fields to change.

IssueRelationUpdateInput

The fields issueRelationUpdate changes. All optional.

Field	Type	Description
`issueId`	`string`	The identifier of the issue that is related.
`relatedIssueId`	`string`	The identifier of the related issue.
`type`	IssueRelationType	The type of relation between the two issues.

IssueRelationDeleteVariables

Variables for the issueRelationDelete mutation.

Field	Type	Description
`id` *	`string`	The relation’s UUID.

IssueRelationType

Value
`blocks`
`duplicate`
`related`
`similar`

SlaDayCountType

Value
`all`
`onlyBusinessDays`

SlaStatus

Value
`Breached`
`Completed`
`Failed`
`HighRisk`
`LowRisk`
`MediumRisk`

CyclePeriod

Value
`after`
`before`
`during`

​Model tree

​IssuesListVariables

​IssueFilter

​NullableNumberComparator

​EstimateComparator

​NullableTimelessDateComparator

​CyclePeriodComparator

​SlaStatusComparator

​NullableUserFilter

​IssueLabelCollectionFilter

​NullableProjectFilter

​RelationExistsComparator

​NullableProjectMilestoneFilter

​NullableCycleFilter

​NullableTemplateFilter

​SourceMetadataComparator

​SubTypeComparator

​WorkflowDefinitionIdComparator

​IssueGetVariables

​IssueCreateVariables

​IssueCreateInput

​IssueUpdateVariables

​IssueUpdateInput

​IssueBatchUpdateVariables

​IssueDeleteVariables

​IssueArchiveVariables

​IssueUnarchiveVariables

​IssueLabelLinkVariables

​IssueSubscriptionVariables

​IssueRelationsListVariables

​IssueRelationGetVariables

​IssueRelationCreateVariables

​IssueRelationCreateInput

​IssueRelationUpdateVariables

​IssueRelationUpdateInput

​IssueRelationDeleteVariables

​IssueRelationType

​SlaDayCountType

​SlaStatus

​CyclePeriod

Model tree

IssuesListVariables