Skip to content
Alter

Zoho: Get Timelines

Zoho timelines.getTimelines: arguments, response, policy and SDK examples.

← Timelines operations · Get started

Operation zoho.gettimelines

Provider route: GET /crm/v8/{module}/{recordId}/__timeline. Alter supplies the connection’s credentials and routing.

Call through Alter

Section titled “Call through Alter”

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";


async function execute(input: Parameters<ZohoIntegration["timelines"]["getTimelines"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.timelines.getTimelines(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}
import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration


async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.timelines.get_timelines(arguments)
        result = await call.wait()
        return result.body_json()

Input

Section titled “Input”
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.modulestringRequired within parentMaximum length: 255
path.recordIdstringRequired within parentMaximum length: 255
queryobjectOptionalAdditional keys: not allowed
query.include_inner_detailsstringOptionalMaximum length: 255
query.page_tokenstringOptionalMaximum length: 255
query.pageintegerOptionalFormat: int32
query.per_pageintegerOptionalOne of: 3
Format: int32
query.filtersstringOptionalMaximum length: 255
query.sort_bystringOptionalOne of: audited_time
query.sort_orderstringOptionalOne of: asc, desc
query.include_timeline_typesstringOptionalMaximum length: 255
query.includestringOptionalMaximum length: 255

Response

Section titled “Response”

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeRepresents the successful response body for the Get Timelines operation.
Additional keys: not allowed
$ (anyOf 1).__timelinearrayOptionalRepresents an array of timeline entries for the specified CRM record. Each entry captures an audited event with its timestamp, action type, source, and contextual details.
Maximum items: 200
$ (anyOf 1).__timeline[]objectEach itemRepresents a single timeline entry recording an audited event on the CRM record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].actionJSONOptional
$ (anyOf 1).__timeline[].action (anyOf 1)stringAlternativeRepresents the type of action performed on the record. This field is nullable.
Known values: converted, score_updated, survey_sent, email_notification_sent, consent_mail_sent, recommendation_feedback, webhook_invoked, function_executed, owner_assigned, owner_reassigned, task_assigned, create_record, create_connected_record, transition_executed, command_center_log, state_change_on_edit, process_exit_on_edit, abrupt_exit, abrupt_exit_api, portals_invitation_sent, portals_invitation_accepted, portals_invitation_resent, portals_user_type_activated, portals_user_type_deactivated, portal_user_transferred, portal_user_deleted, image_removed, image_uploaded, find_and_merge_duplicate, tag_removed, tag_added, tags_overwritten, submitted_for_review, resubmitted_for_review, reviewed, rejected_in_review, reviewed_during_resubmit, entered_in_system, updated, webinar_invitation_sent, backstage_invitation_sent, comment_to_post, reply_to_message, reply_to_comment, like_to_comment, retweet, reply_to_tweet, process_entry, process_exit, escalation_mail, open, click, bounce, received, missed, added, image_approved, image_approval, rejection_mail_sent, final_approval_mail_copy_sent, automatic_transition, record_exit_on_edit, state_executed, automatic_transition_action, user_signature, Message_template_sent, action_executed, mass_association, deleted, restored, subform_automation_trigger
$ (anyOf 1).__timeline[].action (anyOf 2)nullAlternativeRepresents the type of action performed on the record. This field is nullable.
Known values: converted, score_updated, survey_sent, email_notification_sent, consent_mail_sent, recommendation_feedback, webhook_invoked, function_executed, owner_assigned, owner_reassigned, task_assigned, create_record, create_connected_record, transition_executed, command_center_log, state_change_on_edit, process_exit_on_edit, abrupt_exit, abrupt_exit_api, portals_invitation_sent, portals_invitation_accepted, portals_invitation_resent, portals_user_type_activated, portals_user_type_deactivated, portal_user_transferred, portal_user_deleted, image_removed, image_uploaded, find_and_merge_duplicate, tag_removed, tag_added, tags_overwritten, submitted_for_review, resubmitted_for_review, reviewed, rejected_in_review, reviewed_during_resubmit, entered_in_system, updated, webinar_invitation_sent, backstage_invitation_sent, comment_to_post, reply_to_message, reply_to_comment, like_to_comment, retweet, reply_to_tweet, process_entry, process_exit, escalation_mail, open, click, bounce, received, missed, added, image_approved, image_approval, rejection_mail_sent, final_approval_mail_copy_sent, automatic_transition, record_exit_on_edit, state_executed, automatic_transition_action, user_signature, Message_template_sent, action_executed, mass_association, deleted, restored, subform_automation_trigger
$ (anyOf 1).__timeline[].audited_timestringRequired within parentRepresents the timestamp at which the action was audited and recorded in the timeline.
Format: date-time
$ (anyOf 1).__timeline[].automation_detailsJSONOptional
$ (anyOf 1).__timeline[].automation_details (anyOf 1)objectAlternativeRepresents the automation context associated with the timeline entry, including details about triggered workflows, approval processes, scoring rules, ownership changes, and review processes.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 1).approval_processModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process
$ (anyOf 1).__timeline[].automation_details (anyOf 1).assigned_toobjectOptionalRepresents the user to whom the record was assigned by an automation action.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 1).assigned_to.idstringOptionalRepresents the unique ID of the user assigned to the record.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).assigned_to.namestringOptionalRepresents the name of the user assigned to the record.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).group_idJSONOptional
$ (anyOf 1).__timeline[].automation_details (anyOf 1).group_id (anyOf 1)stringAlternativeAutomation group ID for subform workflow triggers. Only present when action is ‘subform_automation_trigger’.
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).group_id (anyOf 2)nullAlternativeAutomation group ID for subform workflow triggers. Only present when action is ‘subform_automation_trigger’.
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).moduleJSONOptional
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 1)objectAlternativeModule information for subform automation. Only present when action is ‘subform_automation_trigger’.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 1).api_namestringOptionalModule API name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 1).idstringOptionalModule ID
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 1).namestringOptionalModule display name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 2)nullAlternativeModule information for subform automation. Only present when action is ‘subform_automation_trigger’.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 2).api_namestringOptionalModule API name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 2).idstringOptionalModule ID
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).module (anyOf 2).namestringOptionalModule display name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).ownerModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow owner
$ (anyOf 1).__timeline[].automation_details (anyOf 1).pathfinderModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder
$ (anyOf 1).__timeline[].automation_details (anyOf 1).review_processModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process
$ (anyOf 1).__timeline[].automation_details (anyOf 1).ruleobjectOptionalRepresents the automation rule that triggered the timeline event.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 1).rule.idstringOptionalRepresents the unique ID of the automation rule.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).rule.namestringOptionalRepresents the name of the automation rule.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).scoring_ruleModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule
$ (anyOf 1).__timeline[].automation_details (anyOf 1).typestringOptionalRepresents the type of automation action that triggered the timeline event, such as a workflow, Approval Process, or Scoring Rule.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 1).workflowModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow workflow
$ (anyOf 1).__timeline[].automation_details (anyOf 2)nullAlternativeRepresents the automation context associated with the timeline entry, including details about triggered workflows, approval processes, scoring rules, ownership changes, and review processes.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 2).approval_processModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process
$ (anyOf 1).__timeline[].automation_details (anyOf 2).assigned_toobjectOptionalRepresents the user to whom the record was assigned by an automation action.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 2).assigned_to.idstringOptionalRepresents the unique ID of the user assigned to the record.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).assigned_to.namestringOptionalRepresents the name of the user assigned to the record.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).group_idJSONOptional
$ (anyOf 1).__timeline[].automation_details (anyOf 2).group_id (anyOf 1)stringAlternativeAutomation group ID for subform workflow triggers. Only present when action is ‘subform_automation_trigger’.
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).group_id (anyOf 2)nullAlternativeAutomation group ID for subform workflow triggers. Only present when action is ‘subform_automation_trigger’.
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).moduleJSONOptional
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 1)objectAlternativeModule information for subform automation. Only present when action is ‘subform_automation_trigger’.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 1).api_namestringOptionalModule API name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 1).idstringOptionalModule ID
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 1).namestringOptionalModule display name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 2)nullAlternativeModule information for subform automation. Only present when action is ‘subform_automation_trigger’.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 2).api_namestringOptionalModule API name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 2).idstringOptionalModule ID
Format: int64
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).module (anyOf 2).namestringOptionalModule display name
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).ownerModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow owner
$ (anyOf 1).__timeline[].automation_details (anyOf 2).pathfinderModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder
$ (anyOf 1).__timeline[].automation_details (anyOf 2).review_processModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process
$ (anyOf 1).__timeline[].automation_details (anyOf 2).ruleobjectOptionalRepresents the automation rule that triggered the timeline event.
Additional keys: not allowed
$ (anyOf 1).__timeline[].automation_details (anyOf 2).rule.idstringOptionalRepresents the unique ID of the automation rule.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).rule.namestringOptionalRepresents the name of the automation rule.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).scoring_ruleModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule
$ (anyOf 1).__timeline[].automation_details (anyOf 2).typestringOptionalRepresents the type of automation action that triggered the timeline event, such as a workflow, Approval Process, or Scoring Rule.
Maximum length: 255
$ (anyOf 1).__timeline[].automation_details (anyOf 2).workflowModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow workflow
$ (anyOf 1).__timeline[].converted_recordJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 1)objectAlternativeRepresents the details of a converted record associated with the timeline entry.
Additional keys: not allowed
$ (anyOf 1).__timeline[].converted_record (anyOf 1).idJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 1).id (anyOf 1)stringAlternativeRepresents the unique ID of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).id (anyOf 2)nullAlternativeRepresents the unique ID of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).moduleJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 1).module (anyOf 1)objectAlternativeRepresents the module information for the converted record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].converted_record (anyOf 1).module (anyOf 1).api_namestringOptionalRepresents the API name of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).module (anyOf 1).idstringOptionalRepresents the unique ID of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).module (anyOf 2)nullAlternativeRepresents the module information for the converted record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].converted_record (anyOf 1).module (anyOf 2).api_namestringOptionalRepresents the API name of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).module (anyOf 2).idstringOptionalRepresents the unique ID of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).nameJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 1).name (anyOf 1)stringAlternativeRepresents the name of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 1).name (anyOf 2)nullAlternativeRepresents the name of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2)nullAlternativeRepresents the details of a converted record associated with the timeline entry.
Additional keys: not allowed
$ (anyOf 1).__timeline[].converted_record (anyOf 2).idJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 2).id (anyOf 1)stringAlternativeRepresents the unique ID of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).id (anyOf 2)nullAlternativeRepresents the unique ID of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).moduleJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 2).module (anyOf 1)objectAlternativeRepresents the module information for the converted record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].converted_record (anyOf 2).module (anyOf 1).api_namestringOptionalRepresents the API name of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).module (anyOf 1).idstringOptionalRepresents the unique ID of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).module (anyOf 2)nullAlternativeRepresents the module information for the converted record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].converted_record (anyOf 2).module (anyOf 2).api_namestringOptionalRepresents the API name of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).module (anyOf 2).idstringOptionalRepresents the unique ID of the module containing the converted record.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).nameJSONOptional
$ (anyOf 1).__timeline[].converted_record (anyOf 2).name (anyOf 1)stringAlternativeRepresents the name of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].converted_record (anyOf 2).name (anyOf 2)nullAlternativeRepresents the name of the converted record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].done_byJSONOptional
$ (anyOf 1).__timeline[].done_by (anyOf 1)objectAlternativeThe details of the user who modified the record such as the name, ID, name and ID of that user’s profile, and the user type.
Additional keys: not allowed
$ (anyOf 1).__timeline[].done_by (anyOf 1).idstringOptionalRepresents the unique ID of the user who performed the action.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 1).namestringOptionalRepresents the name of the user who performed the action.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 1).profileobjectOptionalRepresents the user profile associated with the user who performed the action.
Additional keys: not allowed
$ (anyOf 1).__timeline[].done_by (anyOf 1).profile.idstringOptionalRepresents the unique ID of the user’s profile.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 1).profile.namestringOptionalRepresents the name of the user’s profile.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 1).type__sstringOptionalRepresents the type of the user who performed the action, such as a standard user, admin, or system user.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 2)nullAlternativeThe details of the user who modified the record such as the name, ID, name and ID of that user’s profile, and the user type.
Additional keys: not allowed
$ (anyOf 1).__timeline[].done_by (anyOf 2).idstringOptionalRepresents the unique ID of the user who performed the action.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 2).namestringOptionalRepresents the name of the user who performed the action.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 2).profileobjectOptionalRepresents the user profile associated with the user who performed the action.
Additional keys: not allowed
$ (anyOf 1).__timeline[].done_by (anyOf 2).profile.idstringOptionalRepresents the unique ID of the user’s profile.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 2).profile.namestringOptionalRepresents the name of the user’s profile.
Maximum length: 255
$ (anyOf 1).__timeline[].done_by (anyOf 2).type__sstringOptionalRepresents the type of the user who performed the action, such as a standard user, admin, or system user.
Maximum length: 255
$ (anyOf 1).__timeline[].extensionJSONOptional
$ (anyOf 1).__timeline[].extension (anyOf 1)objectAlternativeRepresents the extension details associated with a signal-type timeline entry, including the extension namespace, ID, and signal information.
Additional keys: not allowed
$ (anyOf 1).__timeline[].extension (anyOf 1).idstringOptionalRepresents the unique ID of the extension that generated the signal.
Maximum length: 255
$ (anyOf 1).__timeline[].extension (anyOf 1).namespacestringOptionalRepresents the namespace of the extension that generated the signal.
Maximum length: 255
$ (anyOf 1).__timeline[].extension (anyOf 1).signalModelOptionalExpand Get Timelines — response body — timeline, info timeline item extension id, namespace, signal signal
$ (anyOf 1).__timeline[].extension (anyOf 2)nullAlternativeRepresents the extension details associated with a signal-type timeline entry, including the extension namespace, ID, and signal information.
Additional keys: not allowed
$ (anyOf 1).__timeline[].extension (anyOf 2).idstringOptionalRepresents the unique ID of the extension that generated the signal.
Maximum length: 255
$ (anyOf 1).__timeline[].extension (anyOf 2).namespacestringOptionalRepresents the namespace of the extension that generated the signal.
Maximum length: 255
$ (anyOf 1).__timeline[].extension (anyOf 2).signalModelOptionalExpand Get Timelines — response body — timeline, info timeline item extension id, namespace, signal signal
$ (anyOf 1).__timeline[].field_historyJSONOptional
$ (anyOf 1).__timeline[].field_history (anyOf 1)arrayAlternativeContains the following details:

* api_name - the API name of the field that was modified. This is available by default in the response.
* _value - the old and new values of the field. This is available by default in the response.

The following values are available when you specify the `include_inner_details` parameter:

* enable_colour_code - indicates whether color coding is enabled for the picklist field.
* data_type - the data type of the field that was modified.
* pick_list_values - details of the various values available for the picklist.

Maximum items: 100
$ (anyOf 1).__timeline[].field_history (anyOf 1)[]ModelEach itemExpand Get Timelines — response body — timeline, info timeline item field history Contains the following details: item
$ (anyOf 1).__timeline[].field_history (anyOf 2)nullAlternativeContains the following details:

* api_name - the API name of the field that was modified. This is available by default in the response.
* _value - the old and new values of the field. This is available by default in the response.

The following values are available when you specify the `include_inner_details` parameter:

* enable_colour_code - indicates whether color coding is enabled for the picklist field.
* data_type - the data type of the field that was modified.
* pick_list_values - details of the various values available for the picklist.

Maximum items: 100
$ (anyOf 1).__timeline[].field_history (anyOf 2)[]ModelEach itemExpand Get Timelines — response body — timeline, info timeline item field history Contains the following details: item
$ (anyOf 1).__timeline[].idstringOptionalRepresents the unique ID of the timeline entry.
Maximum length: 255
$ (anyOf 1).__timeline[].recordobjectOptionalRepresents the CRM record associated with the timeline entry.
Additional keys: not allowed
$ (anyOf 1).__timeline[].record.countJSONOptional
$ (anyOf 1).__timeline[].record.count (anyOf 1)stringAlternativeRepresents the count of records associated with this timeline entry. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].record.count (anyOf 2)nullAlternativeRepresents the count of records associated with this timeline entry. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].record.idJSONOptional
$ (anyOf 1).__timeline[].record.id (anyOf 1)stringAlternativeRepresents the unique ID of the associated CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].record.id (anyOf 2)nullAlternativeRepresents the unique ID of the associated CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].record.moduleJSONRequired within parent
$ (anyOf 1).__timeline[].record.module (anyOf 1)objectAlternativeRepresents the module information for the associated CRM record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].record.module (anyOf 1).api_namestringRequired within parentRepresents the API name of the module containing the associated CRM record.
Maximum length: 255
$ (anyOf 1).__timeline[].record.module (anyOf 1).idstringRequired within parentRepresents the unique ID of the module containing the associated CRM record.
Maximum length: 255
$ (anyOf 1).__timeline[].record.module (anyOf 2)nullAlternativeRepresents the module information for the associated CRM record.
Additional keys: not allowed
$ (anyOf 1).__timeline[].record.module (anyOf 2).api_namestringRequired within parentRepresents the API name of the module containing the associated CRM record.
Maximum length: 255
$ (anyOf 1).__timeline[].record.module (anyOf 2).idstringRequired within parentRepresents the unique ID of the module containing the associated CRM record.
Maximum length: 255
$ (anyOf 1).__timeline[].record.nameJSONOptional
$ (anyOf 1).__timeline[].record.name (anyOf 1)stringAlternativeRepresents the name of the associated CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].record.name (anyOf 2)nullAlternativeRepresents the name of the associated CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_recordJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 1)objectAlternativeThe name and ID of the parent record which the task, call, or meeting belongs to.
Additional keys: not allowed
$ (anyOf 1).__timeline[].related_record (anyOf 1).idJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 1).id (anyOf 1)stringAlternativeRepresents the unique ID of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 1).id (anyOf 2)nullAlternativeRepresents the unique ID of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 1).moduleJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 1).module (anyOf 1)ModelAlternativeExpand Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_2b0dda6c2f47
$ (anyOf 1).__timeline[].related_record (anyOf 1).module (anyOf 2)ModelAlternativeExpand Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_633d561b2023
$ (anyOf 1).__timeline[].related_record (anyOf 1).nameJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 1).name (anyOf 1)stringAlternativeRepresents the name of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 1).name (anyOf 2)nullAlternativeRepresents the name of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 2)nullAlternativeThe name and ID of the parent record which the task, call, or meeting belongs to.
Additional keys: not allowed
$ (anyOf 1).__timeline[].related_record (anyOf 2).idJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 2).id (anyOf 1)stringAlternativeRepresents the unique ID of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 2).id (anyOf 2)nullAlternativeRepresents the unique ID of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 2).moduleJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 2).module (anyOf 1)ModelAlternativeExpand Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_2b0dda6c2f47
$ (anyOf 1).__timeline[].related_record (anyOf 2).module (anyOf 2)ModelAlternativeExpand Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_633d561b2023
$ (anyOf 1).__timeline[].related_record (anyOf 2).nameJSONOptional
$ (anyOf 1).__timeline[].related_record (anyOf 2).name (anyOf 1)stringAlternativeRepresents the name of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].related_record (anyOf 2).name (anyOf 2)nullAlternativeRepresents the name of the related CRM record. This field is nullable.
Maximum length: 255
$ (anyOf 1).__timeline[].sourcestringOptionalRepresents the source system or trigger origin of the timeline event.
Known values: unknown, crm_ui, crm_api, webform, outlook, crm_mobile, qb, social, workflow, import, migration, convert, system_generated, mass_update, google, microsoft, mass_update_via_scheduler, mass_change_owner_via_scheduler, mass_delete_via_crm_ui, mass_delete_via_crm_api, mass_delete_via_clean_up, phonebrifge_api, zoho_docs, mass_addition_via_ui, zoho_projects, sandbox, approval_manual, approval_auto, approval_reject, approval_reject_action, mass_update_via_blueprint, mail_parser, email_workflow, bcc_dropbox, zoho_finance, zoho_forms, zoho_desk, zoho_survey, google_adwords, zoho_calendar, salesiq, zoho_mail, custom_function, zoho_campaign, zoho_creator, salesinbox, mass_email, zoho_recruit, sheet_view, sample_data, calendar_booking, zia_voice, blueprint, approval_process, case_escalation, assignment_rules, macro, mass_transfer, deduplication, findandmerge, zohowebinar, portals, zohobackstage, bulkapi, prediction, facebook, twitter, review_process, rfm_segmentation, orchestration, gmail, wizard, scoringrule, scoringrule_config, scoringrule_config_downgrade, bulk_action, bulk_action_revert, mass_delete_user_thread, unsubscribe, subform, bigin, zoho_crm, automatic_deal_creation, mailchimp, business_messages, pathfinder, notification, assignment_restriction, massconvert, sandbox_conflict_resolve, threshold_reallocation, rollup_summary, constant_contact, manual_and_cpq, cadences, series_config, series_config_downgrade, abm, prediction_config, prediction_result, zia_config, zia_result, email-in, recommendation_feedback, autolog_mobile, record_locking_configuration, canvas_view, portalform, record_locking_configuration_bulk, field_of_lookup, cscript_sdk, kiosk, pf_instant_parent_to_child_sync, pf_bulk_parent_to_child_sync, pf_instant_child_to_parent_sync, pf_bulk_child_to_parent_sync, zia_did_config_added, zia_did_config_delete, zia_did_config_enabled, zia_did_config_disabled, zohoone, change_owner, data_enrichment, awaiting_approval, commandcenter_service, connected_workflow, zia_agent
$ (anyOf 1).__timeline[].typestringOptionalRepresents the type of the timeline entry. Possible values: timeline (standard CRM activity), signal (event from a Zoho extension).
Known values: timeline, signal
$ (anyOf 1).infoobjectOptionalRepresents the pagination metadata for the timeline response.
Additional keys: not allowed
$ (anyOf 1).info.countJSONRequired within parent
$ (anyOf 1).info.count (anyOf 1)integerAlternativeRepresents the number of timeline entries returned in the current page.
Format: int32
$ (anyOf 1).info.count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.more_recordsbooleanRequired within parentIndicates whether additional timeline entries are available beyond the current page.
$ (anyOf 1).info.next_page_tokenJSONRequired within parent
$ (anyOf 1).info.next_page_token (anyOf 1)stringAlternativeRepresents the token to retrieve the next page of timeline entries. The value is null when no more pages are available.
Maximum length: 255
$ (anyOf 1).info.next_page_token (anyOf 2)nullAlternativeRepresents the token to retrieve the next page of timeline entries. The value is null when no more pages are available.
Maximum length: 255
$ (anyOf 1).info.pageJSONRequired within parent
$ (anyOf 1).info.page (anyOf 1)integerAlternativeRepresents the current page number in the paginated results.
Format: int32
$ (anyOf 1).info.page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.per_pageJSONRequired within parent
$ (anyOf 1).info.per_page (anyOf 1)integerAlternativeThe number of records you want to fetch per page. You can use this parameter for the first page only. For the subsequent pages, you must use the “page_token” parameter.
Format: int32
$ (anyOf 1).info.per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.previous_page_tokenJSONRequired within parent
$ (anyOf 1).info.previous_page_token (anyOf 1)stringAlternativeRepresents the token to retrieve the previous page of timeline entries. The value is null on the first page.
Maximum length: 255
$ (anyOf 1).info.previous_page_token (anyOf 2)nullAlternativeRepresents the token to retrieve the previous page of timeline entries. The value is null on the first page.
Maximum length: 255
$ (anyOf 2)nullAlternative

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process, Get Timelines — response body — timeline, info timeline item field history Contains the following details: item, Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_2b0dda6c2f47, Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_633d561b2023, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow owner, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow scoring rule, Get Timelines — response body — timeline, info timeline item extension id, namespace, signal signal, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow workflow

Schemas

Section titled “Schemas”

15 more schemas are linked from the tables above, on the schema pages.

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process
FieldTypePresenceDescription and constraints
$objectRootRepresents the Approval Process details associated with the timeline entry.
Additional keys: not allowed
approver_detailsobjectOptionalRepresents the details of the approver who acted on the Approval Process.
Additional keys: not allowed
approver_details.idstringOptionalRepresents the unique ID of the approver user.
Maximum length: 255
approver_details.namestringOptionalRepresents the name of the approver user.
Maximum length: 255
commentsstringOptionalRepresents the comments added during the Approval Process action.
Maximum length: 1000
current_stageJSONOptional
current_stage (anyOf 1)integerAlternativeRepresents the current stage number of the Approval Process at the time of the timeline event.
Format: int32
current_stage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
delegate_detailsModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process delegate details
next_approverarrayOptionalRepresents an array of the next approvers in the Approval Process sequence.
Maximum items: 50
next_approver[]objectEach itemRepresents a single next approver in the Approval Process.
Additional keys: not allowed
next_approver[].idstringOptionalRepresents the unique ID of the next approver user.
Maximum length: 255
next_approver[].namestringOptionalRepresents the name of the next approver user.
Maximum length: 255
rejected_detailsModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process rejected details
takeover_reasonstringOptionalRepresents the reason provided for the approval task takeover.
Maximum length: 255
takeover_stagestringOptionalRepresents the approval stage at which the takeover occurred.
Maximum length: 255

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process delegate details, Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow approval process rejected details

Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item
FieldTypePresenceDescription and constraints
$objectRootRepresents a single field change recorded in the timeline event.
Additional keys: not allowed
_valueModelOptionalExpand Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item value
api_namestringOptionalRepresents the API name of the field that changed.
Maximum length: 255
data_typestringOptionalRepresents the data type of the field that changed.
Maximum length: 255
enable_colour_codebooleanOptionalIndicates whether color coding is enabled for the changed field's values.
field_labelstringOptionalRepresents the display label of the field that changed.
Maximum length: 255
idstringOptionalRepresents the unique ID of the changed field.
Maximum length: 255
pick_list_valuesarrayOptionalRepresents an array of picklist options for the changed field, applicable when the field is a picklist type.
Maximum items: 200
pick_list_values[]ModelEach itemExpand Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item pick list values item

Referenced models: Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item pick list values item, Get Timelines — response body — timeline, info timeline item field history **Contains the following details:** item value

Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_2b0dda6c2f47
FieldTypePresenceDescription and constraints
$objectRootRepresents the module information for the related CRM record.
Additional keys: not allowed
api_namestringOptionalRepresents the API name of the module containing the related CRM record.
Maximum length: 255
idstringOptionalRepresents the unique ID of the module containing the related CRM record.
Maximum length: 255
namestringOptionalRepresents the display name of the module containing the related CRM record.
Maximum length: 255
Get Timelines — response body — timeline, info timeline item related record id, module, name module api name, id, name — shared_module_633d561b2023
FieldTypePresenceDescription and constraints
$nullRootRepresents the module information for the related CRM record.
Additional keys: not allowed
api_namestringOptionalRepresents the API name of the module containing the related CRM record.
Maximum length: 255
idstringOptionalRepresents the unique ID of the module containing the related CRM record.
Maximum length: 255
namestringOptionalRepresents the display name of the module containing the related CRM record.
Maximum length: 255
Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow owner
FieldTypePresenceDescription and constraints
$objectRootRepresents the ownership change details recorded in the timeline entry, including previous and new owner information.
Additional keys: not allowed
idstringOptionalRepresents the unique ID of the owner user.
Maximum length: 255
namestringOptionalRepresents the name of the owner user.
Maximum length: 255
newobjectOptionalRepresents the new owner assigned to the record after the ownership change.
Additional keys: not allowed
new.idstringOptionalRepresents the unique ID of the new owner user.
Maximum length: 255
new.namestringOptionalRepresents the name of the new owner user.
Maximum length: 255
oldobjectOptionalRepresents the previous owner of the record before the ownership change.
Additional keys: not allowed
old.idstringOptionalRepresents the unique ID of the previous owner user.
Maximum length: 255
old.namestringOptionalRepresents the name of the previous owner user.
Maximum length: 255
Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder
FieldTypePresenceDescription and constraints
$objectRootRepresents the Blueprint process details associated with the timeline entry, including the triggered state and entry or exit flags.
Additional keys: not allowed
process_entrybooleanOptionalIndicates whether the Blueprint process entry action was triggered for this timeline event.
process_exitbooleanOptionalIndicates whether the Blueprint process exit action was triggered for this timeline event.
stateModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder state

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow pathfinder state

Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process
FieldTypePresenceDescription and constraints
$objectRootRepresents the review process details associated with the timeline entry.
Additional keys: not allowed
deactivated_processModelOptionalExpand Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process deactivated process
delugeobjectOptionalRepresents the Deluge script associated with the review process event.
Additional keys: not allowed
deluge.idstringOptionalRepresents the unique ID of the Deluge script.
Maximum length: 255
deluge.namestringOptionalRepresents the name of the Deluge script.
Maximum length: 255
rejectionobjectOptionalRepresents the rejection details when the review process was rejected.
Additional keys: not allowed
rejection.commentstringOptionalRepresents the comment provided with the rejection.
Maximum length: 255
rejection.reasonstringOptionalRepresents the reason provided for the rejection.
Maximum length: 255

Referenced models: Get Timelines — response body — timeline, info timeline item automation details approval process, assigned to, group id, module, owner, pathfinder, review process, rule, scoring rule, type, workflow review process deactivated process

Policy, approvals and errors

Section titled “Policy, approvals and errors”

SDK function policy ID: zoho.gettimelines. Catalog operation: getTimelines. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.

LinkedInTwitter