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

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#cycleslistvariables">CyclesListVariables</a><div className="tree-children"><div className="tree-node"><a href="#cyclefilter">CycleFilter</a><div className="tree-children"><div className="tree-node"><a href="#cyclefilter">CycleFilter</a> <span className="tree-note">above</span></div></div></div></div></div><div className="tree-node"><a href="#cyclegetvariables">CycleGetVariables</a></div><div className="tree-node"><a href="#cycleupdatevariables">CycleUpdateVariables</a><div className="tree-children"><div className="tree-node"><a href="#cycleupdateinput">CycleUpdateInput</a></div></div></div><div className="tree-node"><a href="#cyclearchivevariables">CycleArchiveVariables</a></div><div className="tree-node"><a href="#cyclestartupcomingcycletodayvariables">CycleStartUpcomingCycleTodayVariables</a></div></div></div>

## CyclesListVariables

Variables for the `cycles` 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`          | [CycleFilter](#cyclefilter)                                                    | Narrow the cycles returned. Filter on `is_active.eq` for a team's current cycle.                                                  |
  | `includeArchived` | `boolean`                                                                      | Include archived cycles in the results.                                                                                           |
  | `orderBy`         | [PaginationOrderBy](/charter/charter/packs/linear/workspace/objects#paginationorderby) | Sort by 'createdAt' or 'updatedAt'.                                                                                               |
</div>

## CycleFilter

A filter over cycles, or over an issue's `cycle`.

<div className="reference-table">
  | Field             | Type                                                                           | Description                                                              |
  | ----------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
  | `id`              | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)           | Filter by cycle UUID.                                                    |
  | `name`            | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)   | Comparator for the cycle name.                                           |
  | `number`          | [NumberComparator](/charter/charter/packs/linear/workspace/objects#numbercomparator)   | Filter by the cycle's number.                                            |
  | `startsAt`        | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)       | Filter by when the cycle starts.                                         |
  | `endsAt`          | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)       | Filter by when the cycle ends.                                           |
  | `completedAt`     | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)       | Comparator for the cycle completed at date.                              |
  | `isActive`        | [BooleanComparator](/charter/charter/packs/linear/workspace/objects#booleancomparator) | Filter by whether the cycle is the team's current one.                   |
  | `isNext`          | [BooleanComparator](/charter/charter/packs/linear/workspace/objects#booleancomparator) | Filter by whether the cycle is the team's next one.                      |
  | `isPrevious`      | [BooleanComparator](/charter/charter/packs/linear/workspace/objects#booleancomparator) | Filter by whether the cycle is the team's previous one.                  |
  | `isFuture`        | [BooleanComparator](/charter/charter/packs/linear/workspace/objects#booleancomparator) | Filter by whether the cycle is in the future.                            |
  | `isPast`          | [BooleanComparator](/charter/charter/packs/linear/workspace/objects#booleancomparator) | Filter by whether the cycle is in the past.                              |
  | `team`            | [TeamFilter](/charter/charter/packs/linear/workspace/objects#teamfilter)               | Filter by the team the cycle belongs to.                                 |
  | `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.                                      |
  | `inheritedFromId` | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)           | Comparator for the inherited cycle ID.                                   |
  | `isInCooldown`    | [BooleanComparator](/charter/charter/packs/linear/workspace/objects#booleancomparator) | Comparator for filtering for whether the cycle is currently in cooldown. |
</div>

## CycleGetVariables

Variables for the `cycle` query.

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

## CycleUpdateVariables

Variables for the `cycleUpdate` mutation.

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

## CycleUpdateInput

The fields `cycleUpdate` changes. All optional.

<div className="reference-table">
  | Field         | Type     | Description                                                 |
  | ------------- | -------- | ----------------------------------------------------------- |
  | `name`        | `string` | The custom name of the cycle.                               |
  | `description` | `string` | The cycle description.                                      |
  | `startsAt`    | `string` | The start date of the cycle, as an ISO 8601 timestamp.      |
  | `endsAt`      | `string` | The end date of the cycle, as an ISO 8601 timestamp.        |
  | `completedAt` | `string` | The completion time of the cycle, as an ISO 8601 timestamp. |
</div>

## CycleArchiveVariables

Variables for the `cycleArchive` mutation.

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

## CycleStartUpcomingCycleTodayVariables

Variables for the `cycleStartUpcomingCycleToday` mutation.

<div className="reference-table">
  | Field                                                      | Type     | Description                                    |
  | ---------------------------------------------------------- | -------- | ---------------------------------------------- |
  | `id` <span className="required" title="required">\*</span> | `string` | The UUID of the upcoming cycle to start today. |
</div>