Objects - Charter Docs

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`	InitiativeFilter	Narrow the initiatives returned.
`includeArchived`	`boolean`	Include archived initiatives in the results.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’.

InitiativeFilter

A filter over initiatives.

Field	Type	Description
`id`	IdComparator	Filter by initiative UUID.
`name`	StringComparator	Filter by name.
`status`	StringComparator	Filter by status: ‘Planned’, ‘Proposed’, ‘Active’, ‘Completed’ or ‘Canceled’.
`creator`	UserFilter	Filter by who created the initiative.
`owner`	UserFilter	Filter by the initiative’s owner.
`targetDate`	NullableDateComparator	Filter by the initiative’s target date.
`createdAt`	DateComparator	Filter by when the initiative was created.
`updatedAt`	DateComparator	Filter by when the initiative was last updated.
`slugId`	StringComparator	Comparator for the initiative’s slug.
`customIdentifier`	NullableStringComparator	Comparator for the initiative’s custom identifier.
`priority`	NullableNumberComparator	Comparator for the initiative’s priority.
`health`	StringComparator	Comparator for the initiative’s health.
`healthWithAge`	StringComparator	Comparator for the initiative’s health, with age.
`activityType`	StringComparator	Comparator for the initiative’s activity type.
`startedAt`	NullableDateComparator	Comparator for the initiative’s started date.
`completedAt`	NullableDateComparator	Comparator for the initiative’s completed date.
`canceledAt`	NullableDateComparator	Comparator for the initiative’s canceled date.
`leadTeam`	TeamFilter	Filters that the initiative’s lead team must satisfy.
`labels`	InitiativeLabelCollectionFilter	Filters that the initiative labels must satisfy.

InitiativeLabelCollectionFilter

InitiativeLabelFilter plus collection operators.

Field	Type	Description
`id`	IdComparator	Comparator for the identifier.
`name`	StringComparator	Comparator for the name.

InitiativeGetVariables

Variables for the initiative query.

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

InitiativeCreateVariables

Variables for the initiativeCreate mutation.

Field	Type	Description
`input` *	InitiativeCreateInput	The initiative to create.

InitiativeCreateInput

The input to initiativeCreate.

Field	Type	Description
`name` *	`string`	The name of the initiative.
`description`	`string`	The description of the initiative.
`content`	`string`	The initiative content as markdown.
`status`	InitiativeStatus	The status of the initiative.
`ownerId`	`string`	The owner of the initiative.
`leadTeamId`	`string`	The identifier of the team leading the initiative.
`labelIds`	`string`[]	The identifiers of the labels associated with this initiative.
`priority`	`integer`	The priority of the initiative. 0 = No priority, 1 = Urgent, 2 = High, 3 = Medium, 4 = Low. ≥ 0; ≤ 4
`targetDate`	`string`	The estimated completion date of the initiative, as `YYYY-MM-DD`.
`targetDateResolution`	DateResolutionType	The resolution of the initiative’s estimated completion date.
`icon`	`string`	The icon of the initiative.
`color`	`string`	The color of the initiative, as a hex string.
`sortOrder`	`number`	The sort order of the initiative within the workspace.
`prioritySortOrder`	`number`	The sort order of the initiative within the workspace, when ordered by priority.
`id`	`string`	The identifier in UUID v4 format. If none is provided, the backend will generate one.

InitiativeUpdateVariables

Variables for the initiativeUpdate mutation.

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

InitiativeUpdateInput

The fields the initiativeUpdate mutation changes. All optional.

Field	Type	Description
`name`	`string`	The name of the initiative.
`description`	`string`	The description of the initiative.
`content`	`string`	The initiative content as markdown.
`status`	InitiativeStatus	The status of the initiative.
`ownerId`	`string`	The owner of the initiative.
`leadTeamId`	`string`	The identifier of the team leading the initiative.
`labelIds`	`string`[]	The identifiers of the labels associated with this initiative.
`priority`	`integer`	The priority of the initiative. 0 = No priority, 1 = Urgent, 2 = High, 3 = Medium, 4 = Low. ≥ 0; ≤ 4
`targetDate`	`string`	The estimated completion date of the initiative, as `YYYY-MM-DD`.
`targetDateResolution`	DateResolutionType	The resolution of the initiative’s estimated completion date.
`icon`	`string`	The icon of the initiative.
`color`	`string`	The color of the initiative, as a hex string.
`trashed`	`boolean`	Whether the initiative has been trashed.
`sortOrder`	`number`	The sort order of the initiative within the workspace.
`prioritySortOrder`	`number`	The sort order of the initiative within the workspace, when ordered by priority.
`updateReminderFrequency`	`number`	The frequency at which to prompt for initiative updates. When not set, reminders are inherited from workspace settings.
`updateReminderFrequencyInWeeks`	`number`	The n-weekly frequency at which to prompt for initiative updates. When not set, reminders are inherited from workspace settings.
`frequencyResolution`	FrequencyResolutionType	The resolution type for the update reminder frequency (e.g., weekly, biweekly).
`updateRemindersDay`	Day	The day of the week on which to prompt for initiative updates.
`updateRemindersHour`	`integer`	The hour of the day (0-23) at which to prompt for initiative updates. ≥ 0; ≤ 23

InitiativeIdVariables

Variables for the initiative mutations that take only an id.

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

InitiativeToProjectCreateVariables

Variables for the initiativeToProjectCreate mutation.

Field	Type	Description
`input` *	InitiativeToProjectCreateInput	The project to add to the initiative.

InitiativeToProjectCreateInput

The input to initiativeToProjectCreate — puts a project in an initiative.

Field	Type	Description
`initiativeId` *	`string`	The identifier of the initiative.
`projectId` *	`string`	The identifier of the project.
`sortOrder`	`number`	The sort order of the project within the initiative.
`id`	`string`	The identifier in UUID v4 format. If none is provided, the backend will generate one.

InitiativeToProjectDeleteVariables

Variables for the initiativeToProjectDelete mutation.

Field	Type	Description
`id` *	`string`	The UUID of the initiative-to-project link, not of the project. It comes back from `initiative_get`.

InitiativeUpdatesListVariables

Variables for the initiativeUpdates 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 archived updates in the results.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’.

InitiativeUpdateCreateVariables

Variables for the initiativeUpdateCreate mutation.

Field	Type	Description
`input` *	InitiativeUpdateCreateInput	The status update to post.

InitiativeUpdateCreateInput

The input to initiativeUpdateCreate — a status post on an initiative.

Field	Type	Description
`initiativeId` *	`string`	The initiative to associate the update with.
`body`	`string`	The content of the initiative update in markdown format.
`health`	ProjectHealth	The health of the initiative at the time of the update.
`isDiffHidden`	`boolean`	Whether the diff between the current update and the previous one should be hidden.
`id`	`string`	The identifier in UUID v4 format. If none is provided, the backend will generate one.

InitiativeStatus

Value
`Planned`
`Proposed`
`Active`
`Completed`
`Canceled`

​Model tree

​InitiativesListVariables

​InitiativeFilter

​InitiativeLabelCollectionFilter

​InitiativeGetVariables

​InitiativeCreateVariables

​InitiativeCreateInput

​InitiativeUpdateVariables

​InitiativeUpdateInput

​InitiativeIdVariables

​InitiativeToProjectCreateVariables

​InitiativeToProjectCreateInput

​InitiativeToProjectDeleteVariables

​InitiativeUpdatesListVariables

​InitiativeUpdateCreateVariables

​InitiativeUpdateCreateInput

​InitiativeStatus

Model tree

InitiativesListVariables