Zoho Inventory tasks API
Task Module
Zoho Inventory tasks API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include tasks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 17 operations across 10 paths, and defines 107 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
17 operations
10 paths
107 schemas
4 DELETE4 GET7 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory tasks API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 17
Across 10 paths, the API surfaces 17 operations — 4 DELETE, 4 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
tasks 17
Task Module
POST
/tasks
Add a task
GET
/tasks
List tasks
PUT
/tasks
Update tasks
DELETE
/tasks
Delete tasks
GET
/tasks/{task_id}
Get a task
PUT
/tasks/{task_id}
Update a tasks
DELETE
/tasks/{task_id}
Delete a tasks
POST
/tasks/{task_id}/percentage
Update completed percentage
POST
/tasks/{task_id}/markasopen
Mark task as open
POST
/tasks/{task_id}/markasongoing
Mark task as ongoing
POST
/tasks/{task_id}/markascompleted
Mark task as completed
POST
/tasks/{task_id}/comments
Add comment to task
GET
/tasks/{task_id}/comments
List comments of task
DELETE
/tasks/{task_id}/comments/{comment_id}
Delete comment of task
POST
/tasks/{task_id}/attachment
Add attachment to task
GET
/tasks/{task_id}/documents/{document_id}
Get document of task
DELETE
/tasks/{task_id}/documents/{document_id}
Delete document of task
Schemas 107
The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are update-a-task-request (38 properties), add-a-task-request (38 properties), comment (11 properties), document (7 properties). Each schema is shown below with its type and property counts.
transaction_id
string
ID of the transaction associated with the task.
dependencies
array
List of dependencies for the task.
billing_type
string
Billing type of the task.
client_name
string
Name of the client associated with the task.
parent_status
string
Parent status of the task.
add-task-attachment-response
object
3 properties
task_number
string
Unique number assigned to the task.
add-task-comment-request
object
1 property
1 required
subtask_count
integer
Number of subtasks under the task.
update-percentage-task-request
object
1 property
1 required
get-a-task-response
object
3 properties
update-tasks-response
object
3 properties
comments
array
List of comments for the task.
mail_id
string
Email ID to which the notification has to be sent.
can_push
boolean
Indicates if the task can be sync to client
title
string
Title of the task.
add-task-comment-response
object
3 properties
client_id
string
ID of the client associated with the task.
documents
array
List of files attached to a particular task.
is_subtask
boolean
Indicates whether the task is a subtask.
custom_fields
array
List of custom fields associated with the task
recurring_task_id
string
ID of the recurring task.
mark-ongoing-task-response
object
2 properties
email_account_type
string
Email account type to which the notification has to be sent.
comment
object
Comment on the task.
11 properties
related_entity_value
string
Value of the related entity associated with the task.
task_rate
number
Rate of the task.
document_id
string
ID of the document attached to the task.
task_id
string
ID of the task.
is_sub_task
boolean
Indicates whether the task is a sub task.
related_sub_entity_type
string
Type of the related sub entity associated with the task.
owners
array
List of owners of the task.
update-a-task-response
object
3 properties
created_by_id
string
ID of the user who created the task.
status
string
Status of the task.
owner_ids
string
Comma separated list of owner IDs of the task.
transaction_type
string
Type of transaction associated with the task.
contact_id
string
ID of the contact associated with the task.
document
object
Details of the document attached to the task.
7 properties
email_account_id
string
Email account ID to which the notification has to be sent.
can_show_in_portal
boolean
Indicates whether the document can be shown in the customer portal.
reminder
object
Details of the reminder set for the task.
7 properties
task_number_suffix
string
Suffix of the task number.
update-tasks-request
array
List of tasks to be updated.
list-task-comments-response
object
3 properties
time
string
Time when the comment was made.
due_after
integer
Number of days after which the task is due.
parent_task_number
string
Number of the parent task.
comment_id
string
ID of the comment on the task.
get-a-task-document-response
object
3 properties
operation_type
string
Type of operation performed on the task.
related_entity
integer
Unique value assigned to each entity.
description
string
Description of the comment.
date_description
string
Description of the date when the comment was made.
update-percentage-task-response
object
3 properties
contact_name
string
Name of the contact associated with the task.
commented_by
string
Name of the user who commented on the task.
parent_task_id
string
ID of the parent task.
file_size
integer
Size of the file attached to the task in bytes.
add-a-task-response
object
3 properties
contact_type
string
Type of the contact associated with the task. Allowed values are customer and vendor
is_system_task
boolean
Indicates whether the task is a system task.
system_task_type
integer
Type of the system task.
is_billable
boolean
Indicates whether the task is billable.
file_size_formatted
string
Formatted size of the file attached to the task.
delete-task-document-response
object
2 properties
due_date
string
Due date of the task.
task_number_prefix
string
Prefix of the task number.
owner_id
string
ID of the owner of the task.
comment_type
string
Type of the comment.
due_date_formatted
string
Formatted due date of the task.
mark-completed-task-response
object
2 properties
entity_tags
array
List of tags associated with the task.
send_email_notification
boolean
Indicates whether to send email notification for the task.
parent_task_name
string
Name of the parent task.
parent_id
string
ID of the parent task.
created_time
string
Creation time of the task.
update-a-task-request
object
38 properties
file_type
string
Type of the file attached to the task.
add-a-task-request
object
38 properties
task_description
string
Description of the task.
commented_by_id
string
ID of the user who commented on the task.
task_type
string
Type of the task.
created_time_formatted
string
Formatted creation time of the task.
statuses
array
List of statuses for the task.
completion_percentage
integer
Completion percentage of the task.
attachment_order
integer
Order of the attachment in the task.
email_folder_id
string
Folder ID of the email account to which the notification has to be sent.
delete-tasks-response
object
2 properties
file_name
string
Name of the file attached to the task.
delete-a-task-response
object
2 properties
last_modified_by_id
string
ID of the user who last modified the task.
template_id
string
ID of the template used for the task.
priority
string
Priority of the task. Allowed values are normal , low , high , lowest and highest
related_entity_id
string
ID of the related entity associated with the task.
delete-task-comment-response
object
2 properties
list-tasks-response
object
3 properties
owner_name
string
Name of the owner of the task.
custom_status_id
string
ID of the custom status of the task.
related_sub_entity_id
string
ID of the related sub entity associated with the task.
is_accountant_task
boolean
Indicates whether the task is an accountant task.
is_overdue
boolean
Indicates whether the task is overdue.
mark-open-task-response
object
2 properties
created_by_name
string
Name of the user who created the task.
color_code
string
Color code of the task.
related_entity_type
string
Type of the related entity associated with the task.
mail_attachments
array
List of attachments to be sent along with the email notification.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
#tasks