> ## 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 Documents tools accept.

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#documentslistvariables">DocumentsListVariables</a><div className="tree-children"><div className="tree-node"><a href="#documentfilter">DocumentFilter</a><div className="tree-children"><div className="tree-node"><a href="#contentcomparator">ContentComparator</a></div><div className="tree-node"><a href="#releasefilter">ReleaseFilter</a><div className="tree-children"><div className="tree-node"><a href="#releasefilter">ReleaseFilter</a> <span className="tree-note">above</span></div></div></div><div className="tree-node"><a href="#documentfilter">DocumentFilter</a> <span className="tree-note">above</span></div></div></div></div></div><div className="tree-node"><a href="#documentgetvariables">DocumentGetVariables</a></div><div className="tree-node"><a href="#documentcreatevariables">DocumentCreateVariables</a><div className="tree-children"><div className="tree-node"><a href="#documentcreateinput">DocumentCreateInput</a></div></div></div><div className="tree-node"><a href="#documentupdatevariables">DocumentUpdateVariables</a><div className="tree-children"><div className="tree-node"><a href="#documentupdateinput">DocumentUpdateInput</a></div></div></div><div className="tree-node"><a href="#documentidvariables">DocumentIdVariables</a></div></div></div>

## DocumentsListVariables

Variables for the `documents` 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.                                                      |
  | `filter`          | [DocumentFilter](#documentfilter)                                              | Narrow the documents returned.                                                                                                    |
  | `includeArchived` | `boolean`                                                                      | Include archived documents in the results.                                                                                        |
  | `orderBy`         | [PaginationOrderBy](/charter/charter/packs/linear/workspace/objects#paginationorderby) | Sort by 'createdAt' or 'updatedAt'.                                                                                               |
</div>

## DocumentFilter

A filter over documents.

<div className="reference-table">
  | Field               | Type                                                                           | Description                                       |
  | ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------- |
  | `id`                | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)           | Filter by document UUID.                          |
  | `title`             | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)   | Filter by title.                                  |
  | `slugId`            | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)   | Filter by the document's slug.                    |
  | `creator`           | [UserFilter](/charter/charter/packs/linear/workspace/objects#userfilter)               | Filter by who created the document.               |
  | `project`           | [ProjectFilter](/charter/charter/packs/linear/projects/objects#projectfilter)          | Filter by the project the document belongs to.    |
  | `initiative`        | [InitiativeFilter](/charter/charter/packs/linear/initiatives/objects#initiativefilter) | Filter by the initiative the document belongs to. |
  | `createdAt`         | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)       | Filter by when the document was created.          |
  | `updatedAt`         | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)       | Filter by when the document was last updated.     |
  | `cycle`             | [CycleFilter](/charter/charter/packs/linear/cycles/objects#cyclefilter)                | Filters that the document's cycle must satisfy.   |
  | `issue`             | [IssueFilter](/charter/charter/packs/linear/issues/objects#issuefilter)                | Filters that the document's issue must satisfy.   |
  | `team`              | [TeamFilter](/charter/charter/packs/linear/workspace/objects#teamfilter)               | Filters that the document's team must satisfy.    |
  | `owner`             | [UserFilter](/charter/charter/packs/linear/workspace/objects#userfilter)               | Filters that the document's owner must satisfy.   |
  | `searchableContent` | [ContentComparator](#contentcomparator)                                        | Comparator for the document's searchable content. |
  | `release`           | [ReleaseFilter](#releasefilter)                                                | Filters that the document's release must satisfy. |
</div>

## ReleaseFilter

A filter over releases.

<div className="reference-table">
  | Field  | Type                                                                         | Description                      |
  | ------ | ---------------------------------------------------------------------------- | -------------------------------- |
  | `id`   | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)         | Comparator for the identifier.   |
  | `name` | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator) | Comparator for the release name. |
</div>

## ContentComparator

Substring comparators for a searchable-content field.

<div className="reference-table">
  | Field         | Type     | Description                           |
  | ------------- | -------- | ------------------------------------- |
  | `contains`    | `string` | Contains the given substring.         |
  | `notContains` | `string` | Does not contain the given substring. |
</div>

## DocumentGetVariables

Variables for the `document` query.

<div className="reference-table">
  | Field                                                      | Type     | Description                                    |
  | ---------------------------------------------------------- | -------- | ---------------------------------------------- |
  | `id` <span className="required" title="required">\*</span> | `string` | The document's UUID, or the slug from its URL. |
</div>

## DocumentCreateVariables

Variables for the `documentCreate` mutation.

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

## DocumentCreateInput

The input to `documentCreate`.

<div className="reference-table">
  | Field                                                         | Type        | Description                                                                           |
  | ------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------- |
  | `title` <span className="required" title="required">\*</span> | `string`    | The title of the document.                                                            |
  | `content`                                                     | `string`    | The document content as markdown.                                                     |
  | `projectId`                                                   | `string`    | Related project for the document.                                                     |
  | `initiativeId`                                                | `string`    | Related initiative for the document.                                                  |
  | `issueId`                                                     | `string`    | Related issue for the document.                                                       |
  | `cycleId`                                                     | `string`    | Related cycle for the document.                                                       |
  | `teamId`                                                      | `string`    | Related team for the document.                                                        |
  | `ownerId`                                                     | `string`    | The owner of the document.                                                            |
  | `subscriberIds`                                               | `string`\[] | The identifiers of the users subscribing to this document.                            |
  | `icon`                                                        | `string`    | The icon of the document.                                                             |
  | `color`                                                       | `string`    | The color of the icon, as a hex string.                                               |
  | `lastAppliedTemplateId`                                       | `string`    | The ID of the last template applied to the document.                                  |
  | `releaseId`                                                   | `string`    | Related release for the document.                                                     |
  | `sortOrder`                                                   | `number`    | The order of the item in the resources list.                                          |
  | `id`                                                          | `string`    | The identifier in UUID v4 format. If none is provided, the backend will generate one. |
</div>

## DocumentUpdateVariables

Variables for the `documentUpdate` mutation.

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

## DocumentUpdateInput

The fields `documentUpdate` changes. All optional.

<div className="reference-table">
  | Field                   | Type        | Description                                                                                                                           |
  | ----------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------- |
  | `title`                 | `string`    | The title of the document.                                                                                                            |
  | `content`               | `string`    | The document content as markdown. Replaces the existing content.                                                                      |
  | `projectId`             | `string`    | Related project for the document.                                                                                                     |
  | `initiativeId`          | `string`    | Related initiative for the document.                                                                                                  |
  | `issueId`               | `string`    | Related issue for the document.                                                                                                       |
  | `cycleId`               | `string`    | Related cycle for the document.                                                                                                       |
  | `teamId`                | `string`    | Related team for the document.                                                                                                        |
  | `ownerId`               | `string`    | The owner of the document.                                                                                                            |
  | `subscriberIds`         | `string`\[] | The identifiers of the users subscribing to this document.                                                                            |
  | `icon`                  | `string`    | The icon of the document.                                                                                                             |
  | `color`                 | `string`    | The color of the icon, as a hex string.                                                                                               |
  | `trashed`               | `boolean`   | Whether the document has been trashed.                                                                                                |
  | `lastAppliedTemplateId` | `string`    | The ID of the last template applied to the document.                                                                                  |
  | `releaseId`             | `string`    | Related release for the document.                                                                                                     |
  | `sortOrder`             | `number`    | The order of the item in the resources list.                                                                                          |
  | `hiddenAt`              | `string`    | The time at which the document was hidden, as an ISO 8601 timestamp. This schema cannot send null to unhide — absent means unchanged. |
</div>

## DocumentIdVariables

Variables for the document mutations that take only an id.

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