> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

# Objects

> Every object and enum the Inbox tools accept.

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#notificationslistvariables">NotificationsListVariables</a></div><div className="tree-node"><a href="#notificationgetvariables">NotificationGetVariables</a></div><div className="tree-node"><a href="#notificationupdatevariables">NotificationUpdateVariables</a><div className="tree-children"><div className="tree-node"><a href="#notificationupdateinput">NotificationUpdateInput</a></div></div></div><div className="tree-node"><a href="#notificationidvariables">NotificationIdVariables</a></div><div className="tree-node"><a href="#notificationmarkreadallvariables">NotificationMarkReadAllVariables</a><div className="tree-children"><div className="tree-node"><a href="#notificationentityinput">NotificationEntityInput</a></div></div></div><div className="tree-node"><a href="#favoritecreatevariables">FavoriteCreateVariables</a><div className="tree-children"><div className="tree-node"><a href="#favoritecreateinput">FavoriteCreateInput</a></div></div></div><div className="tree-node"><a href="#favoriteupdatevariables">FavoriteUpdateVariables</a><div className="tree-children"><div className="tree-node"><a href="#favoriteupdateinput">FavoriteUpdateInput</a></div></div></div><div className="tree-node"><a href="#favoritedeletevariables">FavoriteDeleteVariables</a></div><div className="tree-node"><a href="#customviewslistvariables">CustomViewsListVariables</a></div><div className="tree-node"><a href="#customviewgetvariables">CustomViewGetVariables</a></div><div className="tree-node"><a href="#customviewcreatevariables">CustomViewCreateVariables</a><div className="tree-children"><div className="tree-node"><a href="#customviewcreateinput">CustomViewCreateInput</a><div className="tree-children"><div className="tree-node"><a href="#feeditemfilter">FeedItemFilter</a><div className="tree-children"><div className="tree-node"><a href="#feeditemfilter">FeedItemFilter</a> <span className="tree-note">above</span></div></div></div></div></div></div></div><div className="tree-node"><a href="#customviewdeletevariables">CustomViewDeleteVariables</a></div></div></div>

## NotificationsListVariables

Variables for the `notifications` connection.

<div className="reference-table">
  | Field             | Type                                                                           | Description                                                                                                                       |
  | ----------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
  | `first`           | `integer`                                                                      | How many results to return. Linear returns 50 by default. <span className="field-constraints">≥ 1; ≤ 250; defaults to `50`</span> |
  | `after`           | `string`                                                                       | The `endCursor` from the previous page's `pageInfo`, to fetch the next page.                                                      |
  | `includeArchived` | `boolean`                                                                      | Include archived notifications in the results.                                                                                    |
  | `orderBy`         | [PaginationOrderBy](/charter/charter/packs/linear/workspace/objects#paginationorderby) | Sort by 'createdAt' or 'updatedAt'.                                                                                               |
</div>

## NotificationGetVariables

Variables for the `notification` query.

<div className="reference-table">
  | Field                                                      | Type     | Description              |
  | ---------------------------------------------------------- | -------- | ------------------------ |
  | `id` <span className="required" title="required">\*</span> | `string` | The notification's UUID. |
</div>

## NotificationUpdateVariables

Variables for the `notificationUpdate` mutation.

<div className="reference-table">
  | Field                                                         | Type                                                | Description              |
  | ------------------------------------------------------------- | --------------------------------------------------- | ------------------------ |
  | `id` <span className="required" title="required">\*</span>    | `string`                                            | The notification's UUID. |
  | `input` <span className="required" title="required">\*</span> | [NotificationUpdateInput](#notificationupdateinput) | The fields to change.    |
</div>

## NotificationUpdateInput

The fields `notificationUpdate` changes. All optional.

<div className="reference-table">
  | Field                | Type     | Description                                                                      |
  | -------------------- | -------- | -------------------------------------------------------------------------------- |
  | `readAt`             | `string` | The time at which the notification was marked as read, as an ISO 8601 timestamp. |
  | `snoozedUntilAt`     | `string` | The time until which the notification is snoozed, as an ISO 8601 timestamp.      |
  | `initiativeUpdateId` | `string` | The id of the initiative update related to the notification.                     |
  | `projectUpdateId`    | `string` | The id of the project update related to the notification.                        |
</div>

## NotificationIdVariables

Variables for the notification mutations that take only an id.

<div className="reference-table">
  | Field                                                      | Type     | Description              |
  | ---------------------------------------------------------- | -------- | ------------------------ |
  | `id` <span className="required" title="required">\*</span> | `string` | The notification's UUID. |
</div>

## NotificationMarkReadAllVariables

Variables for the `notificationMarkReadAll` mutation.

<div className="reference-table">
  | Field                                                          | Type                                                | Description                                                                                                |
  | -------------------------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
  | `input` <span className="required" title="required">\*</span>  | [NotificationEntityInput](#notificationentityinput) | Whose notifications to mark as read.                                                                       |
  | `readAt` <span className="required" title="required">\*</span> | `string`                                            | The time to record as the read time, as an ISO 8601 timestamp. Notifications created after it stay unread. |
</div>

## NotificationEntityInput

Which thing's notifications to act on.

<div className="reference-table">
  | Field                   | Type     | Description                                                      |
  | ----------------------- | -------- | ---------------------------------------------------------------- |
  | `id`                    | `string` | The id of the notification.                                      |
  | `issueId`               | `string` | The id of the issue.                                             |
  | `projectId`             | `string` | The id of the project.                                           |
  | `projectUpdateId`       | `string` | The id of the project update.                                    |
  | `initiativeId`          | `string` | The id of the initiative.                                        |
  | `initiativeUpdateId`    | `string` | The id of the initiative update.                                 |
  | `oauthClientApprovalId` | `string` | The id of the OAuth client approval related to the notification. |
</div>

## FavoriteCreateVariables

Variables for the `favoriteCreate` mutation.

<div className="reference-table">
  | Field                                                         | Type                                        | Description       |
  | ------------------------------------------------------------- | ------------------------------------------- | ----------------- |
  | `input` <span className="required" title="required">\*</span> | [FavoriteCreateInput](#favoritecreateinput) | What to favorite. |
</div>

## FavoriteCreateInput

The input to `favoriteCreate`.

<div className="reference-table">
  | Field                  | Type                            | Description                                                         |
  | ---------------------- | ------------------------------- | ------------------------------------------------------------------- |
  | `issueId`              | `string`                        | The identifier of the issue to favorite.                            |
  | `projectId`            | `string`                        | The identifier of the project to favorite.                          |
  | `documentId`           | `string`                        | The identifier of the document to favorite.                         |
  | `cycleId`              | `string`                        | The identifier of the cycle to favorite.                            |
  | `initiativeId`         | `string`                        | The identifier of the initiative to favorite.                       |
  | `customViewId`         | `string`                        | The identifier of the custom view to favorite.                      |
  | `customerId`           | `string`                        | The identifier of the customer to favorite.                         |
  | `labelId`              | `string`                        | The identifier of the issue label to favorite.                      |
  | `projectLabelId`       | `string`                        | The identifier of the project label to favorite.                    |
  | `teamId`               | `string`                        | The identifier of the team to favorite.                             |
  | `userId`               | `string`                        | The identifier of the user to favorite.                             |
  | `folderName`           | `string`                        | The name of a favorite folder to create.                            |
  | `parentId`             | `string`                        | The identifier of the favorite folder to file this under.           |
  | `sortOrder`            | `number`                        | The position of the item in the favorites list.                     |
  | `dashboardId`          | `string`                        | The identifier of the dashboard to favorite.                        |
  | `facetId`              | `string`                        | The identifier of the facet to favorite.                            |
  | `liveFolderPreset`     | `string`                        | The predefined live folder to create.                               |
  | `predefinedViewType`   | `string`                        | The type of the predefined view to favorite.                        |
  | `predefinedViewTeamId` | `string`                        | The identifier of team for the predefined view to favorite.         |
  | `pullRequestId`        | `string`                        | The identifier of the pull request to favorite.                     |
  | `releaseId`            | `string`                        | The identifier of the release to favorite.                          |
  | `releaseNoteId`        | `string`                        | The identifier of the release note to favorite.                     |
  | `releasePipelineId`    | `string`                        | The identifier of the release pipeline to favorite.                 |
  | `workflowDefinitionId` | `string`                        | The identifier of the loop to favorite.                             |
  | `initiativeTab`        | [InitiativeTab](#initiativetab) | The tab of the initiative to favorite.                              |
  | `projectTab`           | [ProjectTab](#projecttab)       | The tab of the project to favorite.                                 |
  | `pipelineTab`          | [PipelineTab](#pipelinetab)     | The tab of the release pipeline to favorite.                        |
  | `id`                   | `string`                        | The identifier. If none is provided, the backend will generate one. |
</div>

## FavoriteUpdateVariables

Variables for the `favoriteUpdate` mutation.

<div className="reference-table">
  | Field                                                         | Type                                        | Description           |
  | ------------------------------------------------------------- | ------------------------------------------- | --------------------- |
  | `id` <span className="required" title="required">\*</span>    | `string`                                    | The favorite's UUID.  |
  | `input` <span className="required" title="required">\*</span> | [FavoriteUpdateInput](#favoriteupdateinput) | The fields to change. |
</div>

## FavoriteUpdateInput

The fields `favoriteUpdate` changes. All optional.

<div className="reference-table">
  | Field        | Type     | Description                                               |
  | ------------ | -------- | --------------------------------------------------------- |
  | `folderName` | `string` | The name of the favorite folder.                          |
  | `parentId`   | `string` | The identifier of the favorite folder to file this under. |
  | `sortOrder`  | `number` | The position of the item in the favorites list.           |
</div>

## FavoriteDeleteVariables

Variables for the `favoriteDelete` mutation.

<div className="reference-table">
  | Field                                                      | Type     | Description          |
  | ---------------------------------------------------------- | -------- | -------------------- |
  | `id` <span className="required" title="required">\*</span> | `string` | The favorite's UUID. |
</div>

## CustomViewsListVariables

Variables for the `customViews` connection.

<div className="reference-table">
  | Field             | Type                                                                           | Description                                                                                                                       |
  | ----------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
  | `first`           | `integer`                                                                      | How many results to return. Linear returns 50 by default. <span className="field-constraints">≥ 1; ≤ 250; defaults to `50`</span> |
  | `after`           | `string`                                                                       | The `endCursor` from the previous page's `pageInfo`, to fetch the next page.                                                      |
  | `includeArchived` | `boolean`                                                                      | Include archived views in the results.                                                                                            |
  | `orderBy`         | [PaginationOrderBy](/charter/charter/packs/linear/workspace/objects#paginationorderby) | Sort by 'createdAt' or 'updatedAt'.                                                                                               |
</div>

## CustomViewGetVariables

Variables for the `customView` query.

<div className="reference-table">
  | Field                                                      | Type     | Description      |
  | ---------------------------------------------------------- | -------- | ---------------- |
  | `id` <span className="required" title="required">\*</span> | `string` | The view's UUID. |
</div>

## CustomViewCreateVariables

Variables for the `customViewCreate` mutation.

<div className="reference-table">
  | Field                                                         | Type                                            | Description         |
  | ------------------------------------------------------------- | ----------------------------------------------- | ------------------- |
  | `input` <span className="required" title="required">\*</span> | [CustomViewCreateInput](#customviewcreateinput) | The view to create. |
</div>

## CustomViewCreateInput

The input to `customViewCreate`.

<div className="reference-table">
  | Field                                                        | Type                                                                           | Description                                                                              |
  | ------------------------------------------------------------ | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
  | `name` <span className="required" title="required">\*</span> | `string`                                                                       | The name of the custom view.                                                             |
  | `description`                                                | `string`                                                                       | The description of the custom view.                                                      |
  | `filterData`                                                 | [IssueFilter](/charter/charter/packs/linear/issues/objects#issuefilter)                | The filter applied to issues in the custom view.                                         |
  | `projectFilterData`                                          | [ProjectFilter](/charter/charter/packs/linear/projects/objects#projectfilter)          | The filter applied to projects in the custom view.                                       |
  | `teamId`                                                     | `string`                                                                       | The team associated with the custom view. Omit it for a view the whole workspace shares. |
  | `projectId`                                                  | `string`                                                                       | The project associated with the custom view.                                             |
  | `ownerId`                                                    | `string`                                                                       | The owner of the custom view.                                                            |
  | `shared`                                                     | `boolean`                                                                      | Whether the custom view is shared with everyone in the organization.                     |
  | `icon`                                                       | `string`                                                                       | The icon of the custom view.                                                             |
  | `color`                                                      | `string`                                                                       | The color of the icon, as a hex string.                                                  |
  | `initiativeId`                                               | `string`                                                                       | The id of the initiative associated with the custom view.                                |
  | `initiativeFilterData`                                       | [InitiativeFilter](/charter/charter/packs/linear/initiatives/objects#initiativefilter) | \[ALPHA] The initiative filter applied to issues in the custom view.                     |
  | `feedItemFilterData`                                         | [FeedItemFilter](#feeditemfilter)                                              | The feed item filter applied to issues in the custom view.                               |
  | `id`                                                         | `string`                                                                       | The identifier in UUID v4 format. If none is provided, the backend will generate one.    |
</div>

## FeedItemFilter

A filter over feed items, used by saved views.

<div className="reference-table">
  | Field           | Type                                                                              | Description                                                                        |
  | --------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
  | `id`            | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)              | Comparator for the identifier.                                                     |
  | `createdAt`     | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)          | Comparator for the created at date.                                                |
  | `updatedAt`     | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)          | Comparator for the updated at date.                                                |
  | `author`        | [UserFilter](/charter/charter/packs/linear/workspace/objects#userfilter)                  | Filters that the feed item author must satisfy.                                    |
  | `projectUpdate` | [ProjectUpdateFilter](/charter/charter/packs/linear/projects/objects#projectupdatefilter) | Filters that the feed item's project update must satisfy.                          |
  | `updateHealth`  | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)      | Comparator for the project or initiative update health: onTrack, atRisk, offTrack. |
  | `updateType`    | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)      | Comparator for the update type: initiative, project, team.                         |
</div>

## CustomViewDeleteVariables

Variables for the `customViewDelete` mutation.

<div className="reference-table">
  | Field                                                      | Type     | Description      |
  | ---------------------------------------------------------- | -------- | ---------------- |
  | `id` <span className="required" title="required">\*</span> | `string` | The view's UUID. |
</div>

## InitiativeTab

<div className="enum-table">
  | Value      |
  | ---------- |
  | `overview` |
  | `projects` |
  | `updates`  |
</div>

## ProjectTab

<div className="enum-table">
  | Value       |
  | ----------- |
  | `customers` |
  | `documents` |
  | `issues`    |
  | `loops`     |
  | `updates`   |
</div>

## PipelineTab

<div className="enum-table">
  | Value          |
  | -------------- |
  | `releaseNotes` |
  | `releases`     |
</div>