openapi: 3.1.0 info: title: Helpcenter Timeline API version: 1.0.0 tags: - name: Timeline 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 to: type: object description: Delegated to additionalProperties: false properties: name: type: string description: To user name maxLength: 255 id: type: string description: To user ID maxLength: 255 approver_details: type: object description: Approver details additionalProperties: false properties: name: type: string description: Approver name maxLength: 255 id: type: string description: Approver ID maxLength: 255 assigned_to: description: Assigned to user information additionalProperties: false type: object properties: name: description: Name of the user maxLength: 255 type: string id: description: ID of the user maxLength: 255 type: string scoring_rule: type: object description: Scoring rule information additionalProperties: false properties: zia_type: type: boolean description: Is Zia type flag negative_score: type: object description: Negative score details additionalProperties: false properties: new: type: - string - 'null' maxLength: 20 description: New negative score old: type: - string - 'null' maxLength: 20 description: Old negative score positive_score: type: object description: Positive score details additionalProperties: false properties: new: type: - string - 'null' maxLength: 20 description: New positive score old: type: - string - 'null' maxLength: 20 description: Old positive score touch_point: type: object description: Touchpoint information additionalProperties: false properties: negative_score: type: object description: Touchpoint negative score details additionalProperties: false properties: new: type: - string - 'null' maxLength: 20 description: New touchpoint negative score old: type: - string - 'null' maxLength: 20 description: Old touchpoint negative score positive_score: type: object description: Touchpoint positive score details additionalProperties: false properties: new: type: - string - 'null' maxLength: 20 description: New touchpoint positive score old: type: - string - 'null' maxLength: 20 description: Old touchpoint positive score score: type: object description: Touchpoint score additionalProperties: false properties: new: type: - string - 'null' maxLength: 20 description: New touchpoint score old: type: - string - 'null' maxLength: 20 description: Old touchpoint score owner: description: Owner information additionalProperties: false type: object properties: name: description: Owner name maxLength: 255 type: string id: description: Owner ID maxLength: 255 type: string new: description: New owner information additionalProperties: false type: object properties: name: description: New owner name maxLength: 255 type: string id: description: New owner ID maxLength: 255 type: string old: description: Old owner information additionalProperties: false type: object properties: name: description: Old owner name maxLength: 255 type: string id: description: Old owner ID maxLength: 255 type: string review_process: type: object description: Review process details additionalProperties: false properties: deluge: type: object description: Deluge script information additionalProperties: false properties: name: type: string description: Deluge script name maxLength: 255 id: type: string description: Deluge script ID maxLength: 255 deactivated_process: type: object description: Deactivated process information additionalProperties: false properties: name: type: string description: Deactivated process name maxLength: 255 id: type: - string - 'null' description: Deactivated process ID maxLength: 255 rejection: type: object description: Rejection details additionalProperties: false properties: reason: type: string description: Rejection reason maxLength: 255 comment: type: string description: Rejection comment maxLength: 255 record: type: object description: Record information additionalProperties: false properties: name: type: - string - 'null' description: Record name maxLength: 255 id: type: - string - 'null' description: Record ID maxLength: 255 count: type: - string - 'null' description: Record count maxLength: 255 module: type: - object - 'null' description: Module information additionalProperties: false properties: api_name: type: string description: Module API name maxLength: 255 id: type: string description: Module ID maxLength: 255 required: - api_name - id required: - module converted_record: type: - object - 'null' description: Converted record information additionalProperties: false properties: name: type: - string - 'null' description: Converted record name maxLength: 255 id: type: - string - 'null' description: Converted record ID maxLength: 255 module: type: - object - 'null' description: Module information additionalProperties: false properties: api_name: type: string description: Module API name maxLength: 255 id: type: string description: Module ID maxLength: 255 field_history: type: - array - 'null' description: Field history maxItems: 100 items: type: object description: Field change additionalProperties: false properties: data_type: type: string description: Field data type maxLength: 255 enable_colour_code: type: boolean description: Enable colour code flag pick_list_values: type: array description: Picklist values maxItems: 200 items: type: object description: Picklist value additionalProperties: false properties: display_value: type: string description: Display value maxLength: 255 sequence_number: type: integer format: int32 description: Sequence number reference_value: type: string description: Reference value maxLength: 255 colour_code: type: - string - 'null' description: Colour code maxLength: 255 actual_value: type: string description: Actual value maxLength: 255 id: type: string description: Picklist value ID maxLength: 255 type: type: string description: Picklist type maxLength: 255 field_label: type: string description: Field label maxLength: 255 api_name: type: string description: Field API name maxLength: 255 id: type: string description: Field ID maxLength: 255 _value: type: object description: Field values additionalProperties: false properties: new: type: - string - 'null' description: New value maxLength: 255 old: type: - string - 'null' description: Old value maxLength: 255 type: type: string description: Type of timeline enum: - timeline - signal required: - audited_time info: type: object description: Pagination information additionalProperties: false properties: next_page_token: type: - string - 'null' description: Next page token maxLength: 255 previous_page_token: type: - string - 'null' description: Previous page token maxLength: 255 count: type: integer format: int32 description: Number of records in the current page more_records: type: boolean description: Indicates if more records are available page: type: integer format: int32 description: Current page number per_page: type: integer format: int32 description: Number of records per page required: - count - more_records - page - per_page - next_page_token - previous_page_token '204': description: No Content Response '400': description: Bad Request content: application/json: schema: oneOf: - type: object description: Invalid module error response additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_MODULE message: type: string description: Error message enum: - the module name given seems to be invalid details: type: object description: Error details additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Resource path index - type: object description: Error response with invalid data additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 1000 details: type: object description: Error details additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Resource path index required: - resource_path_index - type: object description: Error response with unsupported or pattern mismatch additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - NOT_SUPPORTED - INVALID_DATA - PATTERN_NOT_MATCHED message: type: string description: Error message maxLength: 1000 details: type: object description: Error details additionalProperties: false properties: param_name: type: string description: Parameter name maxLength: 255 - type: object description: Error response with invalid parameter additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 1000 details: type: object description: Error details additionalProperties: false properties: param_name: type: string description: Parameter name maxLength: 255 required: - param_name tags: - Timeline components: parameters: PerPage: name: per_page description: Number of records per page in: query required: false schema: type: integer format: int32 enum: - 3 Module: description: The API module name (e.g., Leads, Contacts, etc.) name: module in: path required: true schema: type: string maxLength: 255 SortOrder: name: sort_order description: Sort order for the timelines in: query required: false schema: type: string enum: - asc - desc IncludeTimelineType: name: include_timeline_type description: Type of timeline to include in: query required: false schema: type: string maxLength: 255 Include: name: include description: Additional data to include in: query required: false schema: type: string maxLength: 255 PageToken: name: page_token description: Token for pagination in: query required: false schema: type: string maxLength: 255 Filter: name: filter description: Filter criteria for timelines in: query required: false schema: type: string maxLength: 255 IncludeInnerDetails: name: include_inner_details description: Flag to include inner details in: query required: false schema: type: string maxLength: 255 SortBy: name: sort_by description: Field to sort the timelines by in: query required: false schema: type: string enum: - audited_time RecordId: name: recordId description: The ID of the record for which timelines are to be fetched in: path required: true schema: type: string maxLength: 255 Page: name: page description: Page number for pagination in: query required: false schema: type: integer format: int32 securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter