Automation Tasks

An Automation Task is an activity assigned to a user when Workflow Rules, Blueprints, or Approval Processes are executed.

Purpose

To retrieve the list of automation tasks configured in your Zoho CRM organization.

Endpoints

GET /settings/automation/tasks
GET /settings/automation/tasks/{task_ID}

Request Details

Request URL

To retrieve all tasks:
{api-domain}/crm/{version}/settings/automation/tasks

To get a specific task:
{api-domain}/crm/{version}/settings/automation/tasks/{task_ID}

Supported modules

Leads, Accounts, Contacts, Deals, Tasks, Meetings, Calls, Products, Quotes, Sales Orders, Purchase Orders, Invoices, Campaigns, Vendors, Price Books, Cases, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.automation_actions.{operation_type}

Possible operation types

ALL - Full access to tasks
READ - Get tasks

Parameters

The below parameters are applicable only for the endpoint to retrieve all tasks

feature_typestring, optional
To retrieve tasks based on their feature type.
Possible values: workflow, blueprint, approval_process
modulestring, optional
To retrieve tasks based on their module.
per_pageinteger, optional
Specify how many tasks to return per page. The default and the maximum possible value is 200.
Possible values: Positive integer values only.
pageinteger, optional
To get the list of tasks from the respective pages. The default value is 1.
Possible values: Positive integer values only.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/tasks/6660682000001465116"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON

idlong
Unique ID of the task.
namestring
Display name of the task.
moduleobject
Represents the module API name and ID of the module the task is associated with.
field_mappingsJSON array
Consists of the fields from the Tasks module mapped to Automation Task fields for automatic task creation.
- fieldJSON object
  Represents the API name and ID of the field present in the Tasks module.
- typestring
  The type of value for the task field.
  Possible values:
  merge_field - dynamic value generated from value of the fields of the module for which the task is created.
  static - fixed value
  execution_time - date or datetime based value
- valuestring or JSON object
  Denotes the value of the Tasks fields. The value is different for each specified type.
- display_valuestring
  Consists of a description of the value.
feature_typestring
Represents the feature type the task is associated with.
Possible values: workflow, blueprint, approval_process.
lock_statusJSON object
Represents the lock status of the task.
- lockedBoolean
  Boolean value that represents whether the task is locked.
editableBoolean
Represents whether the task can be modified.
deletableBoolean
Represents whether the task can be deleted.
associatedBoolean
Indicates whether the automation task is currently linked to an automation, such as a workflow, blueprint, or approval process.

Sample Response

Copied{
    "tasks": [
        {
            "created_time": "2025-07-09T06:45:30+05:30",
            "lock_status": {
                "locked": false
            },
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "6660682000000002175"
            },
            "related_module": null,
            "deletable": true,
            "source": "crm",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "notify": false,
            "feature_type": "workflow",
            "field_mappings": [
                {
                    "display_value": "ee",
                    "field": {
                        "api_name": "Subject",
                        "id": "6660682000000002271"
                    },
                    "type": "static",
                    "value": "ee"
                },
                {
                    "display_value": "Trigger Date plus 2 day(s)",
                    "field": {
                        "api_name": "Due_Date",
                        "id": "6660682000000002273"
                    },
                    "type": "execution_time",
                    "value": {
                        "period": "days",
                        "unit": "2",
                        "trigger_field": "${CURRENTTIME}",
                        "sign": "plus"
                    }
                },
                {
                    "display_value": "Patricia Boyle",
                    "field": {
                        "api_name": "Owner",
                        "id": "6660682000000002269"
                    },
                    "type": "static",
                    "value": {
                        "name": "Patricia Boyle",
                        "id": "6660682000000501001"
                    }
                },
                {
                    "display_value": "In Progress",
                    "field": {
                        "api_name": "Status",
                        "id": "6660682000000002279"
                    },
                    "type": "static",
                    "value": "In Progress"
                },
                {
                    "display_value": "Highest",
                    "field": {
                        "api_name": "Priority",
                        "id": "6660682000000002281"
                    },
                    "type": "static",
                    "value": "Highest"
                },
                {
                    "display_value": "22",
                    "field": {
                        "api_name": "Description",
                        "id": "6660682000000002291"
                    },
                    "type": "static",
                    "value": "22"
                },
                {
                    "display_value": "Same day as due date plus 0 day(s) 12:00 AM",
                    "field": {
                        "api_name": "Remind_At",
                        "id": "6660682000000025017"
                    },
                    "type": "execution_time",
                    "value": {
                        "notify_type": "email",
                        "period": "days",
                        "unit": "0",
                        "trigger_field": "${!Tasks.Due_Date}",
                        "sign": "plus",
                        "time": "00:00"
                    }
                }
            ],
            "modified_time": "2025-07-09T13:47:37+05:30",
            "associated": false,
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "name": "ee",
            "id": "6660682000001465116"
        }
    ]
}

Possible Errors

INVALID_REQUEST_METHODHTTP 400
Invalid HTTP method to access the API URL.
Resolution: Check the HTTP Method of the request.
INVALID_DATAHTTP 400
Feature type is invalid
Resolution: Provide valid feature type.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to retrieve automation tasks. Create a new token with valid scope. Refer to the Scope section for details.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call.
NO_PERMISSIONHTTP 403
Permission denied.
Resolution: This error occurs when the user doesn't have permission. Contact administrator to obtain manage workflow permission.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to Request URL section for details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.