Task#
Parameters for creating and updating tasks via the V1 API.
Classes:
| Name | Description |
|---|---|
CreateItemV1 |
Model for creating a checklist item via the V1 API. |
CreateTaskV1 |
Model for creating a task via the V1 API. |
UpdateItemV1 |
Model for updating a checklist item via the V1 API. |
UpdateTaskV1 |
Model for updating a task via the V1 API. |
pydantic-model
#
Bases: BaseModel
Model for creating a checklist item via the V1 API.
This model is used to create a checklist item via the V1 API. It directly maps to
the 'items' field in the create task
documentation. It is used in the CreateTaskV1 model.
Show JSON schema:
{
"additionalProperties": false,
"description": "Model for creating a checklist item via the V1 API.\n\nThis model is used to create a checklist item via the V1 API. It directly maps to\nthe 'items' field in the [create task](https://developer.ticktick.com/docs#/openapi?id=create-task)\ndocumentation. It is used in the `CreateTaskV1` model.",
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Subtask title",
"title": "Title"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Start Date"
},
"is_all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "All day",
"title": "Is All Day"
},
"sort_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The order of checklist item",
"title": "Sort Order"
},
"time_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The time zone in which the Start time is specified",
"title": "Time Zone"
},
"status": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "The completion status of checklist item",
"title": "Status"
},
"completed_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Completed time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Completed Time"
}
},
"title": "CreateItemV1",
"type": "object"
}
Config:
extra:forbid
Fields:
-
title(str | None) -
start_date(str | None) -
is_all_day(bool | None) -
sort_order(int | None) -
time_zone(str | None) -
status(bool | None) -
completed_time(str | None)
pydantic-field
#
completed_time: str | None = None
Completed time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
start_date: str | None = None
Start date and time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
time_zone: str | None = None
The time zone in which the Start time is specified
pydantic-model
#
Bases: BaseModel
Model for creating a task via the V1 API.
This model is used to create a task via the V1 API. It directly maps to the create task documentation in the API docs.
Show JSON schema:
{
"$defs": {
"CreateItemV1": {
"additionalProperties": false,
"description": "Model for creating a checklist item via the V1 API.\n\nThis model is used to create a checklist item via the V1 API. It directly maps to\nthe 'items' field in the [create task](https://developer.ticktick.com/docs#/openapi?id=create-task)\ndocumentation. It is used in the `CreateTaskV1` model.",
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Subtask title",
"title": "Title"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Start Date"
},
"is_all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "All day",
"title": "Is All Day"
},
"sort_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The order of checklist item",
"title": "Sort Order"
},
"time_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The time zone in which the Start time is specified",
"title": "Time Zone"
},
"status": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "The completion status of checklist item",
"title": "Status"
},
"completed_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Completed time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Completed Time"
}
},
"title": "CreateItemV1",
"type": "object"
}
},
"additionalProperties": false,
"description": "Model for creating a task via the V1 API.\n\nThis model is used to create a task via the V1 API. It directly maps to the\n[create task](https://developer.ticktick.com/docs#/openapi?id=create-task)\ndocumentation in the API docs.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Task id",
"title": "Id"
},
"title": {
"description": "Task title",
"title": "Title",
"type": "string"
},
"project_id": {
"description": "Task project id. (Note: This is missing in the API docs)",
"title": "Project Id",
"type": "string"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Task content",
"title": "Content"
},
"desc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Task description of checklist",
"title": "Desc"
},
"is_all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "All day",
"title": "Is All Day"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Start Date"
},
"due_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Due date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Due Date"
},
"time_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The time zone in which the time is specified",
"title": "Time Zone"
},
"reminders": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Lists of reminders specific to the task",
"title": "Reminders"
},
"repeat_flag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Recurring rules of task",
"title": "Repeat Flag"
},
"priority": {
"anyOf": [
{
"enum": [
0,
1,
3,
5
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The priority of task, default is '0'",
"title": "Priority"
},
"sort_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The order of task",
"title": "Sort Order"
},
"items": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CreateItemV1"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The list of checklist items to create",
"title": "Items"
}
},
"required": [
"title",
"project_id"
],
"title": "CreateTaskV1",
"type": "object"
}
Config:
extra:forbid
Fields:
-
id(str | None) -
title(str) -
project_id(str) -
content(str | None) -
desc(str | None) -
is_all_day(bool | None) -
start_date(str | None) -
due_date(str | None) -
time_zone(str | None) -
reminders(list[str] | None) -
repeat_flag(str | None) -
priority(Literal[0, 1, 3, 5] | None) -
sort_order(int | None) -
items(list[CreateItemV1] | None)
pydantic-field
#
due_date: str | None = None
Due date and time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
items: list[CreateItemV1] | None = None
The list of checklist items to create
pydantic-field
#
priority: Literal[0, 1, 3, 5] | None = None
The priority of task, default is '0'
pydantic-field
#
project_id: str
Task project id. (Note: This is missing in the API docs)
pydantic-field
#
reminders: list[str] | None = None
Lists of reminders specific to the task
pydantic-field
#
start_date: str | None = None
Start date and time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
time_zone: str | None = None
The time zone in which the time is specified
pydantic-model
#
Bases: BaseModel
Model for updating a checklist item via the V1 API.
This model is used to update a checklist item via the V1 API. It directly maps to
the 'items' field in the update task
documentation. It is used in the UpdateTaskV1 model.
Show JSON schema:
{
"additionalProperties": false,
"description": "Model for updating a checklist item via the V1 API.\n\nThis model is used to update a checklist item via the V1 API. It directly maps to\nthe 'items' field in the [update task](https://developer.ticktick.com/docs#/openapi?id=update-task)\ndocumentation. It is used in the `UpdateTaskV1` model.",
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Subtask title",
"title": "Title"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Start Date"
},
"is_all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "All day",
"title": "Is All Day"
},
"sort_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The order of checklist item",
"title": "Sort Order"
},
"time_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The time zone in which the Start time is specified",
"title": "Time Zone"
},
"status": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "The completion status of checklist item",
"title": "Status"
},
"completed_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Completed time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Completed Time"
}
},
"title": "UpdateItemV1",
"type": "object"
}
Config:
extra:forbid
Fields:
-
title(str | None) -
start_date(str | None) -
is_all_day(bool | None) -
sort_order(int | None) -
time_zone(str | None) -
status(bool | None) -
completed_time(str | None)
pydantic-field
#
completed_time: str | None = None
Completed time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
start_date: str | None = None
Start date and time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
time_zone: str | None = None
The time zone in which the Start time is specified
pydantic-model
#
Bases: BaseModel
Model for updating a task via the V1 API.
This model is used to updating a task via the V1 API. It directly maps to the update task documentation in the API docs.
Show JSON schema:
{
"$defs": {
"UpdateItemV1": {
"additionalProperties": false,
"description": "Model for updating a checklist item via the V1 API.\n\nThis model is used to update a checklist item via the V1 API. It directly maps to\nthe 'items' field in the [update task](https://developer.ticktick.com/docs#/openapi?id=update-task)\ndocumentation. It is used in the `UpdateTaskV1` model.",
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Subtask title",
"title": "Title"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Start Date"
},
"is_all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "All day",
"title": "Is All Day"
},
"sort_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The order of checklist item",
"title": "Sort Order"
},
"time_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The time zone in which the Start time is specified",
"title": "Time Zone"
},
"status": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "The completion status of checklist item",
"title": "Status"
},
"completed_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Completed time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Completed Time"
}
},
"title": "UpdateItemV1",
"type": "object"
}
},
"additionalProperties": false,
"description": "Model for updating a task via the V1 API.\n\nThis model is used to updating a task via the V1 API. It directly maps to the\n[update task](https://developer.ticktick.com/docs#/openapi?id=update-task)\ndocumentation in the API docs.",
"properties": {
"id": {
"description": "Task id",
"title": "Id",
"type": "string"
},
"project_id": {
"description": "Task project id",
"title": "Project Id",
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Task title",
"title": "Title"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Task content",
"title": "Content"
},
"desc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Task description of checklist",
"title": "Desc"
},
"is_all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "All day",
"title": "Is All Day"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Start Date"
},
"due_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Due date and time in `yyyy-MM-dd'T'HH:mm:ssZ` format",
"title": "Due Date"
},
"time_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The time zone in which the time is specified",
"title": "Time Zone"
},
"reminders": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Lists of reminders specific to the task",
"title": "Reminders"
},
"repeat_flag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Recurring rules of task",
"title": "Repeat Flag"
},
"priority": {
"anyOf": [
{
"enum": [
0,
1,
3,
5
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The priority of task, default is '0'",
"title": "Priority"
},
"sort_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The order of task",
"title": "Sort Order"
},
"items": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/UpdateItemV1"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The list of checklist items to update",
"title": "Items"
}
},
"required": [
"id",
"project_id"
],
"title": "UpdateTaskV1",
"type": "object"
}
Config:
extra:forbid
Fields:
-
id(str) -
project_id(str) -
title(str | None) -
content(str | None) -
desc(str | None) -
is_all_day(bool | None) -
start_date(str | None) -
due_date(str | None) -
time_zone(str | None) -
reminders(list[str] | None) -
repeat_flag(str | None) -
priority(Literal[0, 1, 3, 5] | None) -
sort_order(int | None) -
items(list[UpdateItemV1] | None)
pydantic-field
#
due_date: str | None = None
Due date and time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
items: list[UpdateItemV1] | None = None
The list of checklist items to update
pydantic-field
#
priority: Literal[0, 1, 3, 5] | None = None
The priority of task, default is '0'
pydantic-field
#
reminders: list[str] | None = None
Lists of reminders specific to the task
pydantic-field
#
start_date: str | None = None
Start date and time in yyyy-MM-dd'T'HH:mm:ssZ format
pydantic-field
#
time_zone: str | None = None
The time zone in which the time is specified