timelines. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Timelines",
"description": "timelines",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"paths": {
"/{module}/{recordId}/__timeline": {
"get": {
"operationId": "getTimelines",
"summary": "Get Timelines",
"description": "Get Timelines",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Leads.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Contacts.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Accounts.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Deals.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Tasks.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Events.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Calls.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Products.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Vendors.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Campaigns.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Cases.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Solutions.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Pricebooks.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Quotes.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Salesorders.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Purchaseorders.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Custom.READ"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/Module"
},
{
"$ref": "#/components/parameters/RecordId"
},
{
"$ref": "#/components/parameters/IncludeInnerDetails"
},
{
"$ref": "#/components/parameters/PageToken"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/PerPage"
},
{
"$ref": "#/components/parameters/Filter"
},
{
"$ref": "#/components/parameters/SortBy"
},
{
"$ref": "#/components/parameters/SortOrder"
},
{
"$ref": "#/components/parameters/IncludeTimelineType"
},
{
"$ref": "#/components/parameters/Include"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Timeline response object",
"additionalProperties": false,
"properties": {
"__timeline": {
"type": "array",
"description": "Array of timeline entries",
"maxItems": 200,
"items": {
"description": "Timeline entry",
"type": "object",
"additionalProperties": false,
"properties": {
"audited_time": {
"type": "string",
"description": "Time of the audit",
"format": "date-time"
},
"action": {
"type": [
"string",
"null"
],
"description": "Action type",
"enum": [
"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"
]
},
"id": {
"type": "string",
"description": "ID of the timeline entry",
"maxLength": 255
},
"source": {
"type": "string",
"description": "Source of the timeline event",
"enum": [
"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"
]
},
"extension": {
"type": [
"object",
"null"
],
"description": "Extension information",
"additionalProperties": false,
"properties": {
"namespace": {
"type": "string",
"description": "Name of the extension",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the extension",
"maxLength": 255
},
"signal": {
"type": "object",
"description": "Signal information",
"additionalProperties": false,
"properties": {
"display_label": {
"type": "string",
"description": "Display label of the signal",
"maxLength": 255
},
"action": {
"type": "string",
"description": "Action of the signal",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the signal",
"maxLength": 255
},
"medium": {
"type": "string",
"description": "Medium of the signal",
"maxLength": 255
}
}
}
}
},
"done_by": {
"type": [
"object",
"null"
],
"description": "User who performed the action",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the user",
"maxLength": 255
},
"profile": {
"type": "object",
"description": "Profile information",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Profile name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Profile ID",
"maxLength": 255
}
}
},
"type__s": {
"type": "string",
"description": "Type of user",
"maxLength": 255
}
}
},
"related_record": {
"type": [
"object",
"null"
],
"description": "Related record information",
"additionalProperties": false,
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "Name of the related record",
"maxLength": 255
},
"id": {
"type": [
"string",
"null"
],
"description": "ID of the related record",
"maxLength": 255
},
"module": {
"type": [
"object",
"null"
],
"description": "Module information",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Module name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Module ID",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Module API name",
"maxLength": 255
}
}
}
}
},
"automation_details": {
"type": [
"object",
"null"
],
"description": "Automation details",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "Automation type",
"maxLength": 255
},
"rule": {
"type": "object",
"description": "Rule information",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Rule name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Rule ID",
"maxLength": 255
}
}
},
"pathfinder": {
"type": "object",
"description": "Pathfinder information",
"additionalProperties": false,
"properties": {
"process_entry": {
"type": "boolean",
"description": "Process entry flag"
},
"process_exit": {
"type": "boolean",
"description": "Process exit flag"
},
"state": {
"additionalProperties": false,
"type": "object",
"description": "State information",
"properties": {
"trigger_type": {
"type": "string",
"description": "Trigger type",
"maxLength": 255
},
"name": {
"type": "string",
"description": "State name",
"maxLength": 255
},
"is_last_state": {
"type": "boolean",
"description": "Is last state flag"
},
"id": {
"type": "string",
"description": "State ID",
"maxLength": 255
}
}
}
}
},
"workflow": {
"type": "object",
"description": "Workflow information",
"additionalProperties": false,
"properties": {
"field_update_action": {
"type": "array",
"maxItems": 50,
"description": "Field update action details",
"items": {
"type": "object",
"description": "Field update action",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Action name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Action ID",
"maxLength": 255
}
}
}
}
}
},
"approval_process": {
"type": "object",
"description": "Approval process details",
"additionalProperties": false,
"properties": {
"next_approver": {
"type": "array",
"description": "Next approvers",
"maxItems": 50,
"items": {
"type": "object",
"description": "Approver",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Approver name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Approver ID",
"maxLength": 255
}
}
}
},
"comments": {
"type": "string",
"description": "Approval comments",
"maxLength": 1000
},
"takeover_reason": {
"type": "string",
"description": "Reason for takeover",
"maxLength": 255
},
"current_stage": {
"type": "integer",
"format": "int32",
"description": "Current stage number"
},
"takeover_stage": {
"type": "string",
"description": "Takeover stage",
"maxLength": 255
},
"rejected_details": {
"type": "object",
"description": "Rejection details",
"additionalProperties": false,
"properties": {
"stage": {
"type": "object",
"description": "Stage information",
"additionalProperties": false,
"properties": {
"from": {
"type": "string",
"description": "From stage",
"maxLength": 255
},
"to": {
"type": "string",
"description": "To stage",
"maxLength": 255
}
}
},
"name": {
"type": "string",
"description": "Rejected by name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Rejected by ID",
"maxLength": 255
}
}
},
"delegate_details": {
"type": "object",
"description": "Delegation details",
"additionalProperties": false,
"properties": {
"from": {
"type": "object",
"description": "Delegated from",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "From user name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "From user ID",
"maxLength": 255
}
}
},
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-timelines-openapi.json