> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> Get Timelines. Zoho CRM Timelines Get Timelines reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Get Timelines.
Tool ID: `zoho_crm_timelines_get_timelines`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_timelines_get_timelines',
{
"module": "example",
"recordId": "record_123"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_timelines_get_timelines --input '{
"module": "example",
"recordId": "record_123"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"__timeline": [
{
"audited_time": "2026-01-15T12:00:00Z"
}
],
"info": {
"next_page_token": "example",
"previous_page_token": "example",
"count": 123,
"more_records": true,
"page": 123,
"per_page": 123
}
}
}
```
Use `deepline tools get zoho_crm_timelines_get_timelines --json` for the latest machine-readable contract.
## Input reference
Get Timelines
| Name | Type | Required | Default | Details |
| ------------------------------- | ----------------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `payload.module` | `string` | Yes | — | The API module name (e.g., Leads, Contacts, etc.) Maximum length: 255. |
| `payload.recordId` | `string` | Yes | — | The ID of the record for which timelines are to be fetched Maximum length: 255. |
| `payload.include_inner_details` | `string` | No | — | Flag to include inner details Maximum length: 255. |
| `payload.page_token` | `string` | No | — | Token for pagination Maximum length: 255. |
| `payload.page` | `integer` | No | — | Page number for pagination Format: `int32`. |
| `payload.per_page` | `3` | No | — | Number of records per page Allowed: `3`. Format: `int32`. |
| `payload.filter` | `string` | No | — | Filter criteria for timelines Maximum length: 255. |
| `payload.sort_by` | `"audited_time"` | No | — | Field to sort the timelines by Allowed: `audited_time`. |
| `payload.sort_order` | `"asc" \| "desc"` | No | — | Sort order for the timelines Allowed: `asc`, `desc`. |
| `payload.include_timeline_type` | `string` | No | — | Type of timeline to include Maximum length: 255. |
| `payload.include` | `string` | No | — | Additional data to include Maximum length: 255. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get Timelines",
"properties": {
"module": {
"type": "string",
"description": "The API module name (e.g., Leads, Contacts, etc.)",
"maxLength": 255
},
"recordId": {
"type": "string",
"description": "The ID of the record for which timelines are to be fetched",
"maxLength": 255
},
"include_inner_details": {
"type": "string",
"description": "Flag to include inner details",
"maxLength": 255
},
"page_token": {
"type": "string",
"description": "Token for pagination",
"maxLength": 255
},
"page": {
"type": "integer",
"description": "Page number for pagination",
"format": "int32"
},
"per_page": {
"type": "integer",
"description": "Number of records per page",
"enum": [
3
],
"format": "int32"
},
"filter": {
"type": "string",
"description": "Filter criteria for timelines",
"maxLength": 255
},
"sort_by": {
"type": "string",
"description": "Field to sort the timelines by",
"enum": [
"audited_time"
]
},
"sort_order": {
"type": "string",
"description": "Sort order for the timelines",
"enum": [
"asc",
"desc"
]
},
"include_timeline_type": {
"type": "string",
"description": "Type of timeline to include",
"maxLength": 255
},
"include": {
"type": "string",
"description": "Additional data to include",
"maxLength": 255
}
},
"required": [
"module",
"recordId"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Timeline response object |
| `result.data.__timeline` | `array` | No | — | Array of timeline entries Maximum items: 200. |
| `result.data.__timeline[].audited_time` | `string` | Yes | — | Time of the audit Format: `date-time`. |
| `result.data.__timeline[].action` | `"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"` | No | — | Action type Allowed: `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`, See the live schema for the complete constraint. |
| `result.data.__timeline[].id` | `string` | No | — | ID of the timeline entry Maximum length: 255. |
| `result.data.__timeline[].source` | `"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"` | No | — | Source of the timeline event Allowed: `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`, See the live schema for the complete constraint. |
| `result.data.__timeline[].extension` | `object \| null` | No | — | Extension information |
| `result.data.__timeline[].extension.namespace` | `string` | No | — | Name of the extension Maximum length: 255. |
| `result.data.__timeline[].extension.id` | `string` | No | — | ID of the extension Maximum length: 255. |
| `result.data.__timeline[].extension.signal` | `object` | No | — | Signal information |
| `result.data.__timeline[].extension.signal.display_label` | `string` | No | — | Display label of the signal Maximum length: 255. |
| `result.data.__timeline[].extension.signal.action` | `string` | No | — | Action of the signal Maximum length: 255. |
| `result.data.__timeline[].extension.signal.id` | `string` | No | — | ID of the signal Maximum length: 255. |
| `result.data.__timeline[].extension.signal.medium` | `string` | No | — | Medium of the signal Maximum length: 255. |
| `result.data.__timeline[].done_by` | `object \| null` | No | — | User who performed the action |
| `result.data.__timeline[].done_by.name` | `string` | No | — | Name of the user Maximum length: 255. |
| `result.data.__timeline[].done_by.id` | `string` | No | — | ID of the user Maximum length: 255. |
| `result.data.__timeline[].done_by.profile` | `object` | No | — | Profile information |
| `result.data.__timeline[].done_by.profile.name` | `string` | No | — | Profile name Maximum length: 255. |
| `result.data.__timeline[].done_by.profile.id` | `string` | No | — | Profile ID Maximum length: 255. |
| `result.data.__timeline[].done_by.type__s` | `string` | No | — | Type of user Maximum length: 255. |
| `result.data.__timeline[].related_record` | `object \| null` | No | — | Related record information |
| `result.data.__timeline[].related_record.name` | `string \| null` | No | — | Name of the related record Maximum length: 255. |
| `result.data.__timeline[].related_record.id` | `string \| null` | No | — | ID of the related record Maximum length: 255. |
| `result.data.__timeline[].related_record.module` | `object \| null` | No | — | Module information |
| `result.data.__timeline[].related_record.module.name` | `string` | No | — | Module name Maximum length: 255. |
| `result.data.__timeline[].related_record.module.id` | `string` | No | — | Module ID Maximum length: 255. |
| `result.data.__timeline[].related_record.module.api_name` | `string` | No | — | Module API name Maximum length: 255. |
| `result.data.__timeline[].automation_details` | `object \| null` | No | — | Automation details |
| `result.data.__timeline[].automation_details.type` | `string` | No | — | Automation type Maximum length: 255. |
| `result.data.__timeline[].automation_details.rule` | `object` | No | — | Rule information |
| `result.data.__timeline[].automation_details.rule.name` | `string` | No | — | Rule name Maximum length: 255. |
| `result.data.__timeline[].automation_details.rule.id` | `string` | No | — | Rule ID Maximum length: 255. |
| `result.data.__timeline[].automation_details.pathfinder` | `object` | No | — | Pathfinder information |
| `result.data.__timeline[].automation_details.pathfinder.process_entry` | `boolean` | No | — | Process entry flag |
| `result.data.__timeline[].automation_details.pathfinder.process_exit` | `boolean` | No | — | Process exit flag |
| `result.data.__timeline[].automation_details.pathfinder.state` | `object` | No | — | State information |
| `result.data.__timeline[].automation_details.pathfinder.state.trigger_type` | `string` | No | — | Trigger type Maximum length: 255. |
| `result.data.__timeline[].automation_details.pathfinder.state.name` | `string` | No | — | State name Maximum length: 255. |
| `result.data.__timeline[].automation_details.pathfinder.state.is_last_state` | `boolean` | No | — | Is last state flag |
| `result.data.__timeline[].automation_details.pathfinder.state.id` | `string` | No | — | State ID Maximum length: 255. |
| `result.data.__timeline[].automation_details.workflow` | `object` | No | — | Workflow information |
| `result.data.__timeline[].automation_details.workflow.field_update_action` | `array` | No | — | Field update action details Maximum items: 50. |
| `result.data.__timeline[].automation_details.workflow.field_update_action[].name` | `string` | No | — | Action name Maximum length: 255. |
| `result.data.__timeline[].automation_details.workflow.field_update_action[].id` | `string` | No | — | Action ID Maximum length: 255. |
| `result.data.__timeline[].automation_details.approval_process` | `object` | No | — | Approval process details |
| `result.data.__timeline[].automation_details.approval_process.next_approver` | `array` | No | — | Next approvers Maximum items: 50. |
| `result.data.__timeline[].automation_details.approval_process.next_approver[].name` | `string` | No | — | Approver name Maximum length: 255. |
| `result.data.__timeline[].automation_details.approval_process.next_approver[].id` | `string` | No | — | Approver ID Maximum length: 255. |
| `result.data.__timeline[].automation_details.approval_process.comments` | `string` | No | — | Approval comments Maximum length: 1000. |
The table shows the first 50 fields. Use the live contract below for every field.
This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get zoho_crm_timelines_get_timelines --json`.
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)