Tasks

Queries

searchTasks

Searches Tasks

Arguments

• after (String) — A cursor to search after (only include first & after or last & before)
• before (String) — A cursor to search before (only include first & after or last & before)
• filters ([SearchFilterInput!]) — A set of filters to apply
• first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
• last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
• search (String) — A search term to apply
• sortBy (SortTasksBy) — The sort key
• sortDir (SortDirection) — The sort direction

Returns: TaskConnection! — A connection to a list of items.

task

A single Task by ID

Arguments

• id (ID!) — The unique identifier of the Task

Returns: Task — A task that can be attached to a Note

tasksByIds

A list of Tasks by IDs

Arguments

• ids ([ID!]!) — The IDs of the Tasks

Returns: [Task]! — A task that can be attached to a Note

Mutations

createTask

Creates a Task

Arguments

• assigneeIds ([ID!]) — An optional array of User IDs to assign to the Task
• createdInTeamId (ID) — The Team that the Task was created in
• creatorId (ID) — The User who is creating the Task
• customerId (ID) — An ID of the Customer to associate with the Task
• deadline (DeadlineInput) — A deadline for the Task to be completed
• description (String) — The description of the Task
• notifyAssignees (Boolean) — Whether to notify any newly assigned users that the have been assigned to the Task
• repeat (TaskRepeatInput) — When the Task will repeat
• tags ([String!]) — A list of tags to associate with the Task
• timeZone (String) — The timezone of the Task assignees
• title (String) — The title of the Task

Returns: CreateTaskPayload!

deleteTask

🚧

Deprecated: Use deleteTasks instead

Deletes a Task

Arguments

• editorId (ID!) — The ID of the User who is deleting the Task
• id (ID!) — The ID of the Task to delete

Returns: DeleteTaskPayload!

restoreTask

🚧

Deprecated: Use restoreTasks instead

Restores a Task

Arguments

• editorId (ID!) — The ID of the User who is restoring the Task
• id (ID!) — The ID of the Task to restore

Returns: RestoreTaskPayload!

updateTask

Updates a Task

Arguments

• assigneeIds ([ID!]) — An optional array of User IDs to assign to the Task
• completed (Boolean) — Whether the Task has been completed
• deadline (DeadlineInput) — A deadline for the Task to be completed
• description (String) — The description of the Task
• editorId (ID!) — The User who is updating the Task
• id (ID!) — The unique identifier of the Task
• notifyAssignees (Boolean) — Whether to notify any newly assigned users that the have been assigned to the Task
• repeat (TaskRepeatInput) — When the Task will repeat
• tags ([String!]) — A list of tags to associate with the Task
• timeZone (String) — The timezone of the Task assignees
• title (String) — The title of the Task

Returns: UpdateTaskPayload!

Objects

CreateTaskError

Fields

• code (CreateTaskErrorCode!)
• human_readable_message (String!)

CreateTaskFailure

Fields

• errors ([CreateTaskError!]!)

CreateTaskSuccess

Fields

• task (Task!)

DeleteTaskError

Fields

• code (DeleteTaskErrorCode!)
• human_readable_message (String!)

DeleteTaskFailure

Fields

• errors ([DeleteTaskError!]!)

DeleteTaskSuccess

Fields

• task (Task!)

RestoreTaskError

Fields

• code (RestoreTaskErrorCode!)
• human_readable_message (String!)

RestoreTaskFailure

Fields

• errors ([RestoreTaskError!]!)

RestoreTaskSuccess

Fields

• task (Task!)

Task

A task that can be attached to a Note

Fields

• assignees ([User!]!) — The Users that are assigned to the Task
• campaign_draft (CampaignDraft) — The Campaign Draft that the Task is linked to
• completed_at (DateTime) — When the Task was marked as completed
• created_at (DateTime!) — The date the Task was created
• deadline (DateTime) — The deadline of the Task
• deleted_at (DateTime) — When the Task was deleted
• id (ID!) — The unique identifier of the Task
• note (Note!) — The Note that the Task is attached to
• recurrence_rule (String) — The frequency that the Task recurs on in rrule format
• recurring (String) — The frequency that the Task recurs on
• repeat (TaskRepeat) — The frequency that the Task repeats
• segment (Segment) — The Segment the Task is linked to
• time_zone (String) — The time zone of the Task
• timezone (String) — The timezone of the Task — 🚧 Deprecated: Use time_zone instead
• updated_at (DateTime!) — The date the Task was last updated
• web_url (URL!) — The URL to the Task inside the web application — 🚧 Deprecated: No longer supported

TaskConnection

A connection to a list of items.

Fields

• edges ([TaskEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.
• total (Int)

TaskEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (Task) — The item at the end of the edge

TaskRepeat

The frequency and interval for a Task to repeat

Fields

• by_day_of_month (Int) — Only available when selecting MONTHLY for frequency. Available values are 1-28, or -1 to indicate last day of month
• by_days_of_week ([TaskRepeatDayOfWeek!]) — Only available when selecting WEEKLY for frequency
• formatted (String!) — A human-readable description of the recurrence
• frequency (TaskRepeatFrequency!) — A frequency for the recurrence
• interval (Int!) — An interval between recurrences. Defaults to 1, meaning every day, week, month, or year
• rule (String!) — A machine-readable description of the recurrence
• time_zone (String) — An IANA time zone name (e.g. America/New_York)
• timezone (String) — An IANA time zone name (e.g. America/NewYork) — 🚧 _Deprecated: Use time_zone instead

UpdateTaskError

Fields

• code (UpdateTaskErrorCode!)
• human_readable_message (String!)

UpdateTaskFailure

Fields

• errors ([UpdateTaskError!]!)

UpdateTaskSuccess

Fields

• task (Task!)

Unions

CreateTaskPayload

Possible types

• CreateTaskFailure
• CreateTaskSuccess

DeleteTaskPayload

Possible types

• DeleteTaskFailure
• DeleteTaskSuccess

RestoreTaskPayload

Possible types

• RestoreTaskFailure
• RestoreTaskSuccess

UpdateTaskPayload

Possible types

• UpdateTaskFailure
• UpdateTaskSuccess

Input Objects

TaskRepeatInput

The frequency and interval for a Task to repeat

Fields

• by_day_of_month (Int) — Only available when selecting MONTHLY for frequency. Available values are 1-28, or -1 to indicate last day of month
• by_days_of_week ([TaskRepeatDayOfWeek!]) — Only available when selecting WEEKLY for frequency
• frequency (TaskRepeatFrequency!) — A frequency for the recurrence
• interval (Int) — An interval between recurrences. Defaults to 1, meaning every day, week, month, or year
• timezone (NonEmptyString) — An IANA time zone name (e.g. America/New_York)

Enums

CreateTaskErrorCode

Values

• ASSIGNEES_NOT_FOUND — One or more assignees were not found
• CREATOR_NOT_FOUND — The creator was not found
• CUSTOMER_NOT_FOUND — The customer was not found
• DEADLINE_MUST_BE_IN_THE_FUTURE — The deadline must be in the future
• DEADLINE_REQUIRED_WHEN_REPEATS — A deadline is required when the task repeats
• DESCRIPTION_TOO_LONG — The description exceeds the maximum length of 5000 characters
• INVALID_DESCRIPTION_HTML — The description is invalid
• INVALID_REPEAT — The repeat input is invalid
• INVALID_TIME_ZONE — The time zone is invalid
• SEGMENT_NOT_FOUND — The segment was not found
• TEAM_NOT_FOUND — The team was not found
• TIME_ZONE_REQUIRED — A time zone is required when a deadline or repeat is provided

DeleteTaskErrorCode

Values

• EDITOR_NOT_FOUND — The editor was not found
• FORBIDDEN — You do not have permission to perform this action
• TASK_LINKED_TO_V2_CANNOT_BE_MODIFIED — This task is linked to a TaskV2 and cannot be modified directly
• TASK_NOT_FOUND — The task was not found

RestoreTaskErrorCode

Values

• EDITOR_NOT_FOUND — The editor was not found
• FORBIDDEN — You do not have permission to perform this action
• TASK_LINKED_TO_V2_CANNOT_BE_MODIFIED — This task is linked to a TaskV2 and cannot be modified directly
• TASK_NOT_FOUND — The task was not found

SortTasksBy

The available keys to sort Tasks

Values

• CREATED_AT
• DUE_AT
• UPDATED_AT

TaskRepeatDayOfWeek

They day of the week

Values

• FRIDAY
• MONDAY
• SATURDAY
• SUNDAY
• THURSDAY
• TUESDAY
• WEDNESDAY

TaskRepeatFrequency

The interval for recurrence

Values

• DAILY
• MONTHLY
• WEEKLY
• YEARLY

UpdateTaskErrorCode

Values

• ASSIGNEES_NOT_FOUND — One or more assignees were not found
• DEADLINE_MUST_BE_IN_THE_FUTURE — The deadline must be in the future
• DEADLINE_REQUIRED_WHEN_REPEATS — A deadline is required when the task repeats
• DESCRIPTION_TOO_LONG — The description exceeds the maximum length of 5000 characters
• EDITOR_NOT_FOUND — The editor was not found
• FORBIDDEN — You do not have permission to perform this action
• INVALID_DESCRIPTION_HTML — The description is invalid
• INVALID_REPEAT — The repeat input is invalid
• INVALID_TIME_ZONE — The time zone is invalid
• TASK_LINKED_TO_V2_CANNOT_BE_MODIFIED — This task is linked to a TaskV2 and cannot be modified directly
• TASK_NOT_FOUND — The task was not found
• TIME_ZONE_REQUIRED — A time zone is required when a deadline or repeat is provided