Objects - Charter Docs

Model tree

CustomersListVariables

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

CustomerFilter

A filter over customers.

Field	Type	Description
`id`	IdComparator	Filter by customer UUID.
`name`	StringComparator	Filter by name.
`domains`	StringComparator	Filter by one of the customer’s domains.
`externalIds`	StringComparator	Filter by an external id the customer was synced with.
`revenue`	NullableNumberComparator	Filter by the customer’s recorded revenue.
`size`	NullableNumberComparator	Filter by the customer’s recorded size.
`owner`	UserFilter	Filter by the customer’s owner.
`createdAt`	DateComparator	Filter by when the customer was created.
`updatedAt`	DateComparator	Filter by when the customer was last updated.
`slackChannelId`	NullableStringComparator	Comparator for the customer’s linked Slack channel.
`status`	CustomerStatusFilter	Filters that the customer’s status must satisfy.
`tier`	CustomerTierFilter	Filters that the customer’s tier must satisfy.

CustomerStatusFilter

A filter over customer statuses.

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

CustomerTierFilter

A filter over customer tiers.

Field	Type	Description
`id`	IdComparator	Comparator for the identifier.
`displayName`	StringComparator	Comparator for the customer tier display name.

CustomerGetVariables

Variables for the customer query.

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

CustomerCreateVariables

Variables for the customerCreate mutation.

Field	Type	Description
`input` *	CustomerCreateInput	The customer to create.

CustomerCreateInput

The input to customerCreate.

Field	Type	Description
`name` *	`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.

CustomerUpdateVariables

Variables for the customerUpdate mutation.

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

CustomerUpdateInput

The fields customerUpdate changes. All optional.

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.

CustomerDeleteVariables

Variables for the customerDelete mutation.

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

CustomerNeedsListVariables

Variables for the customerNeeds 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.
`filter`	CustomerNeedFilter	Narrow the requests returned.
`includeArchived`	`boolean`	Include archived requests in the results.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’.

CustomerNeedFilter

A filter over customer requests.

Field	Type	Description
`id`	IdComparator	Filter by request UUID.
`priority`	NumberComparator	Filter by the request’s priority.
`customer`	CustomerFilter	Filter by the customer who made the request.
`issue`	IssueFilter	Filter by the issue the request is attached to.
`createdAt`	DateComparator	Filter by when the request was created.
`updatedAt`	DateComparator	Filter by when the request was last updated.
`project`	ProjectFilter	Filters that the request’s project must satisfy.
`comment`	CommentFilter	Filters that the request’s comment must satisfy.

CustomerNeedCreateVariables

Variables for the customerNeedCreate mutation.

Field	Type	Description
`input` *	CustomerNeedCreateInput	The request to record.

CustomerNeedCreateInput

The input to customerNeedCreate.

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.

CustomerNeedUpdateVariables

Variables for the customerNeedUpdate mutation.

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

CustomerNeedUpdateInput

The fields customerNeedUpdate changes. All optional.

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.

CustomerNeedDeleteVariables

Variables for the customerNeedDelete mutation.

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

​Model tree

​CustomersListVariables

​CustomerFilter

​CustomerStatusFilter

​CustomerTierFilter

​CustomerGetVariables

​CustomerCreateVariables

​CustomerCreateInput

​CustomerUpdateVariables

​CustomerUpdateInput

​CustomerDeleteVariables

​CustomerNeedsListVariables

​CustomerNeedFilter

​CustomerNeedCreateVariables

​CustomerNeedCreateInput

​CustomerNeedUpdateVariables

​CustomerNeedUpdateInput

​CustomerNeedDeleteVariables