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

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#customerslistvariables">CustomersListVariables</a><div className="tree-children"><div className="tree-node"><a href="#customerfilter">CustomerFilter</a><div className="tree-children"><div className="tree-node"><a href="#customerstatusfilter">CustomerStatusFilter</a><div className="tree-children"><div className="tree-node"><a href="#customerstatusfilter">CustomerStatusFilter</a> <span className="tree-note">above</span></div></div></div><div className="tree-node"><a href="#customertierfilter">CustomerTierFilter</a><div className="tree-children"><div className="tree-node"><a href="#customertierfilter">CustomerTierFilter</a> <span className="tree-note">above</span></div></div></div><div className="tree-node"><a href="#customerfilter">CustomerFilter</a> <span className="tree-note">above</span></div></div></div></div></div><div className="tree-node"><a href="#customergetvariables">CustomerGetVariables</a></div><div className="tree-node"><a href="#customercreatevariables">CustomerCreateVariables</a><div className="tree-children"><div className="tree-node"><a href="#customercreateinput">CustomerCreateInput</a></div></div></div><div className="tree-node"><a href="#customerupdatevariables">CustomerUpdateVariables</a><div className="tree-children"><div className="tree-node"><a href="#customerupdateinput">CustomerUpdateInput</a></div></div></div><div className="tree-node"><a href="#customerdeletevariables">CustomerDeleteVariables</a></div><div className="tree-node"><a href="#customerneedslistvariables">CustomerNeedsListVariables</a><div className="tree-children"><div className="tree-node"><a href="#customerneedfilter">CustomerNeedFilter</a><div className="tree-children"><div className="tree-node"><a href="#customerfilter">CustomerFilter</a> <span className="tree-note">above</span></div><div className="tree-node"><a href="#customerneedfilter">CustomerNeedFilter</a> <span className="tree-note">above</span></div></div></div></div></div><div className="tree-node"><a href="#customerneedcreatevariables">CustomerNeedCreateVariables</a><div className="tree-children"><div className="tree-node"><a href="#customerneedcreateinput">CustomerNeedCreateInput</a></div></div></div><div className="tree-node"><a href="#customerneedupdatevariables">CustomerNeedUpdateVariables</a><div className="tree-children"><div className="tree-node"><a href="#customerneedupdateinput">CustomerNeedUpdateInput</a></div></div></div><div className="tree-node"><a href="#customerneeddeletevariables">CustomerNeedDeleteVariables</a></div></div></div>

## CustomersListVariables

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

## CustomerFilter

A filter over customers.

<div className="reference-table">
  | Field            | Type                                                                                         | Description                                            |
  | ---------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
  | `id`             | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)                         | Filter by customer UUID.                               |
  | `name`           | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)                 | Filter by name.                                        |
  | `domains`        | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)                 | Filter by one of the customer's domains.               |
  | `externalIds`    | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator)                 | Filter by an external id the customer was synced with. |
  | `revenue`        | [NullableNumberComparator](/charter/charter/packs/linear/issues/objects#nullablenumbercomparator)    | Filter by the customer's recorded revenue.             |
  | `size`           | [NullableNumberComparator](/charter/charter/packs/linear/issues/objects#nullablenumbercomparator)    | Filter by the customer's recorded size.                |
  | `owner`          | [UserFilter](/charter/charter/packs/linear/workspace/objects#userfilter)                             | Filter by the customer's owner.                        |
  | `createdAt`      | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)                     | Filter by when the customer was created.               |
  | `updatedAt`      | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)                     | Filter by when the customer was last updated.          |
  | `slackChannelId` | [NullableStringComparator](/charter/charter/packs/linear/workspace/objects#nullablestringcomparator) | Comparator for the customer's linked Slack channel.    |
  | `status`         | [CustomerStatusFilter](#customerstatusfilter)                                                | Filters that the customer's status must satisfy.       |
  | `tier`           | [CustomerTierFilter](#customertierfilter)                                                    | Filters that the customer's tier must satisfy.         |
</div>

## CustomerStatusFilter

A filter over customer statuses.

<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 customer status name. |
  | `type` | [StringComparator](/charter/charter/packs/linear/workspace/objects#stringcomparator) | Comparator for the customer status type. |
</div>

## CustomerTierFilter

A filter over customer tiers.

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

## CustomerGetVariables

Variables for the `customer` query.

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

## CustomerCreateVariables

Variables for the `customerCreate` mutation.

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

## CustomerCreateInput

The input to `customerCreate`.

<div className="reference-table">
  | Field                                                        | Type        | Description                                                                                                            |
  | ------------------------------------------------------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------- |
  | `name` <span className="required" title="required">\*</span> | `string`    | The name of the customer.                                                                                              |
  | `domains`                                                    | `string`\[] | The domains associated with the customer. Absent, Linear records none.                                                 |
  | `externalIds`                                                | `string`\[] | The ids of the customer in external systems. Absent, Linear records none.                                              |
  | `ownerId`                                                    | `string`    | The identifier of the user who owns the customer.                                                                      |
  | `statusId`                                                   | `string`    | The identifier of the customer's status.                                                                               |
  | `tierId`                                                     | `string`    | The identifier of the customer's tier.                                                                                 |
  | `revenue`                                                    | `integer`   | The annual revenue associated with the customer.                                                                       |
  | `size`                                                       | `integer`   | The number of employees of the customer.                                                                               |
  | `logoUrl`                                                    | `string`    | The URL of the customer's logo.                                                                                        |
  | `slackChannelId`                                             | `string`    | The ID of the Slack channel to link to this customer.                                                                  |
  | `mainSourceId`                                               | `string`    | The primary external source ID for customers with multiple sources. Must be one of the values provided in externalIds. |
  | `id`                                                         | `string`    | The identifier in UUID v4 format. If none is provided, the backend will generate one.                                  |
</div>

## CustomerUpdateVariables

Variables for the `customerUpdate` mutation.

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

## CustomerUpdateInput

The fields `customerUpdate` changes. All optional.

<div className="reference-table">
  | Field            | Type        | Description                                                                                                            |
  | ---------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------- |
  | `name`           | `string`    | The name of the customer.                                                                                              |
  | `domains`        | `string`\[] | The domains associated with the customer.                                                                              |
  | `externalIds`    | `string`\[] | The ids of the customer in external systems.                                                                           |
  | `ownerId`        | `string`    | The identifier of the user who owns the customer.                                                                      |
  | `statusId`       | `string`    | The identifier of the customer's status.                                                                               |
  | `tierId`         | `string`    | The identifier of the customer's tier.                                                                                 |
  | `revenue`        | `integer`   | The annual revenue associated with the customer.                                                                       |
  | `size`           | `integer`   | The number of employees of the customer.                                                                               |
  | `logoUrl`        | `string`    | The URL of the customer's logo.                                                                                        |
  | `slackChannelId` | `string`    | The ID of the Slack channel to link to this customer. This schema cannot send null to unlink — absent means unchanged. |
  | `mainSourceId`   | `string`    | The primary external source ID for customers with multiple sources. Must be one of the values in externalIds.          |
</div>

## CustomerDeleteVariables

Variables for the `customerDelete` mutation.

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

## CustomerNeedsListVariables

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

## CustomerNeedFilter

A filter over customer requests.

<div className="reference-table">
  | Field       | Type                                                                         | Description                                      |
  | ----------- | ---------------------------------------------------------------------------- | ------------------------------------------------ |
  | `id`        | [IdComparator](/charter/charter/packs/linear/workspace/objects#idcomparator)         | Filter by request UUID.                          |
  | `priority`  | [NumberComparator](/charter/charter/packs/linear/workspace/objects#numbercomparator) | Filter by the request's priority.                |
  | `customer`  | [CustomerFilter](#customerfilter)                                            | Filter by the customer who made the request.     |
  | `issue`     | [IssueFilter](/charter/charter/packs/linear/issues/objects#issuefilter)              | Filter by the issue the request is attached to.  |
  | `createdAt` | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)     | Filter by when the request was created.          |
  | `updatedAt` | [DateComparator](/charter/charter/packs/linear/workspace/objects#datecomparator)     | Filter by when the request was last updated.     |
  | `project`   | [ProjectFilter](/charter/charter/packs/linear/projects/objects#projectfilter)        | Filters that the request's project must satisfy. |
  | `comment`   | [CommentFilter](/charter/charter/packs/linear/comments/objects#commentfilter)        | Filters that the request's comment must satisfy. |
</div>

## CustomerNeedCreateVariables

Variables for the `customerNeedCreate` mutation.

<div className="reference-table">
  | Field                                                         | Type                                                | Description            |
  | ------------------------------------------------------------- | --------------------------------------------------- | ---------------------- |
  | `input` <span className="required" title="required">\*</span> | [CustomerNeedCreateInput](#customerneedcreateinput) | The request to record. |
</div>

## CustomerNeedCreateInput

The input to `customerNeedCreate`.

<div className="reference-table">
  | Field                | Type     | Description                                                                                                                                                                          |
  | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `customerId`         | `string` | The ID of the customer this need belongs to.                                                                                                                                         |
  | `customerExternalId` | `string` | The external ID of the customer this need belongs to.                                                                                                                                |
  | `body`               | `string` | The content of the need in markdown format.                                                                                                                                          |
  | `issueId`            | `string` | The ID of the issue this need is attached to.                                                                                                                                        |
  | `projectId`          | `string` | The ID of the project this need is attached to.                                                                                                                                      |
  | `attachmentId`       | `string` | The ID of the attachment this need is associated with.                                                                                                                               |
  | `attachmentUrl`      | `string` | The URL of the attachment this need is associated with.                                                                                                                              |
  | `commentId`          | `string` | The ID of the comment this need is associated with.                                                                                                                                  |
  | `priority`           | `number` | The priority of the need.                                                                                                                                                            |
  | `createdAt`          | `string` | The time at which the customer need 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. |
  | `id`                 | `string` | The identifier in UUID v4 format. If none is provided, the backend will generate one.                                                                                                |
</div>

## CustomerNeedUpdateVariables

Variables for the `customerNeedUpdate` mutation.

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

## CustomerNeedUpdateInput

The fields `customerNeedUpdate` changes. All optional.

<div className="reference-table">
  | Field                         | Type      | Description                                                                                                                                  |
  | ----------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
  | `body`                        | `string`  | The content of the need in markdown format.                                                                                                  |
  | `issueId`                     | `string`  | The ID of the issue this need is attached to.                                                                                                |
  | `projectId`                   | `string`  | The ID of the project this need is attached to.                                                                                              |
  | `priority`                    | `number`  | The priority of the need.                                                                                                                    |
  | `customerId`                  | `string`  | The UUID of the customer to reassign this need to. Cannot be used together with customerExternalId.                                          |
  | `customerExternalId`          | `string`  | The external system ID of the customer to reassign this need to. Cannot be used together with customerId.                                    |
  | `attachmentUrl`               | `string`  | A URL to create a new attachment from and set as the source for this customer need. Replaces any existing manually-added attachment.         |
  | `applyPriorityToRelatedNeeds` | `boolean` | When true and priority is also set, applies the same priority update to all other needs from the same customer on the same issue or project. |
  | `id`                          | `string`  | An optional identifier in UUID v4 format. If provided, will be set as the customer need's ID.                                                |
</div>

## CustomerNeedDeleteVariables

Variables for the `customerNeedDelete` mutation.

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