Zoho CRM: README

GET /Appointments__s/{appointmentId}.

Tool ID: zoho_crm_appointments_get_appointment_by_id

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_appointments_get_appointment_by_id',
  {
    "appointmentId": "appointment_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_appointments_get_appointment_by_id --input '{
  "appointmentId": "appointment_123"
}' --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get zoho_crm_appointments_get_appointment_by_id --json for the complete live contract.

Input reference

appointment mode record get by id

Name	Type	Required	Default	Details
`payload.appointmentId`	`string`	Yes	—	Path parameter: appointmentId Maximum length: 100.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	appointment records get , success response
`result.data.data`	`array`	Yes	—	Field: data Maximum items: 2.
`result.data.data[].Owner`	`object`	Yes	—	Nested schema for Owner
`result.data.data[].Owner.name`	`string`	Yes	—	Field: name Maximum length: 255.
`result.data.data[].Owner.id`	`string`	Yes	—	Field: id Maximum length: 255.
`result.data.data[].Owner.email`	`string`	Yes	—	Field: email Maximum length: 255.
`result.data.data[].$currency_symbol`	`string`	No	—	Field: $currency_symbol Maximum length: 255.
`result.data.data[].Address`	`null \| string`	Yes	—	Field: Address Maximum length: 255.
`result.data.data[].Appointment_Start_Time`	`string`	Yes	—	Field: Appointment_Start_Time Maximum length: 120.
`result.data.data[].Cancellation_Reason`	`null \| string`	Yes	—	Field: Cancellation_Reason Maximum length: 120.
`result.data.data[].$field_states`	`null \| string`	No	—	Field: $field_states Maximum length: 255.
`result.data.data[].Appointment_For`	`object`	Yes	—	Nested schema for Appointment_For
`result.data.data[].Appointment_For.module`	`object`	Yes	—	Nested schema for module
`result.data.data[].Appointment_For.module.api_name`	`string`	Yes	—	Field: api_name Maximum length: 255.
`result.data.data[].Appointment_For.module.id`	`string`	Yes	—	Field: id Maximum length: 255.
`result.data.data[].Appointment_For.name`	`string`	Yes	—	Field: name Maximum length: 255.
`result.data.data[].Appointment_For.id`	`string`	Yes	—	Field: id Maximum length: 255.
`result.data.data[].Rescheduled_To`	`null \| string`	Yes	—	Field: Rescheduled_To Maximum length: 120.
`result.data.data[].$sharing_permission`	`string`	No	—	Field: $sharing_permission Maximum length: 255.
`result.data.data[].Reschedule_Reason`	`null \| string`	Yes	—	Field: Reschedule_Reason Maximum length: 120.
`result.data.data[].Job_Sheet_Name__s`	`null \| string`	Yes	—	Field: Job_Sheet_Name__s Maximum length: 255.
`result.data.data[].Additional_Information`	`null \| string`	Yes	—	Field: Additional_Information Maximum length: 32000.
`result.data.data[].Last_Activity_Time`	`null \| string`	Yes	—	Field: Last_Activity_Time Maximum length: 120.
`result.data.data[].Job_Sheet_Created__s`	`boolean`	Yes	—	Field: Job_Sheet_Created__s
`result.data.data[].Cancelled_Time`	`null \| string`	Yes	—	Field: Cancelled_Time Maximum length: 120.
`result.data.data[].Cancellation_Note`	`null \| string`	Yes	—	Field: Cancellation_Note Maximum length: 2000.
`result.data.data[].Modified_By`	`object`	Yes	—	Nested schema for Modified_By
`result.data.data[].Modified_By.name`	`string`	Yes	—	Field: name Maximum length: 255.
`result.data.data[].Modified_By.id`	`string`	Yes	—	Field: id Maximum length: 255.
`result.data.data[].Modified_By.email`	`string`	Yes	—	Field: email Maximum length: 255.
`result.data.data[].Reschedule_Count`	`integer`	Yes	—	Field: Reschedule_Count Format: `int32`.
`result.data.data[].Rescheduled_By`	`null \| object`	Yes	—	Field: Rescheduled_By
`result.data.data[].Date_1`	`null \| string`	Yes	—	Field: Date_1 Maximum length: 20.
`result.data.data[].id`	`string`	Yes	—	Field: id Maximum length: 255.
`result.data.data[].Rescheduled_Time`	`null \| string`	Yes	—	Field: Rescheduled_Time Maximum length: 120.
`result.data.data[].Remind_At`	`array \| null`	Yes	—	Contains the list of units and period of when you want to get the reminders for the appointment. Maximum items: 100.
`result.data.data[].Remind_At[].period`	`"minutes" \| "hours" \| "days"`	No	—	unit of time for reminder Allowed: `minutes`, `hours`, `days`.
`result.data.data[].Remind_At[].unit`	`integer`	No	—	value for reminder time Format: `int32`.
`result.data.data[].Appointment_End_Time`	`string`	Yes	—	Appointment End time Maximum length: 120.
`result.data.data[].Status`	`string`	Yes	—	Appointment Status Maximum length: 120.
`result.data.data[].Modified_Time`	`string`	Yes	—	Field: Modified_Time Maximum length: 120.
`result.data.data[].Service_Name`	`object`	Yes	—	Nested schema for Service_Name
`result.data.data[].Service_Name.name`	`string`	Yes	—	Field: name Maximum length: 255.
`result.data.data[].Service_Name.id`	`string`	Yes	—	Field: id Maximum length: 255.
`result.data.data[].Created_Time`	`string`	Yes	—	Field: Created_Time Maximum length: 120.
`result.data.data[].Rescheduled_From`	`null \| string`	Yes	—	Field: Rescheduled_From Maximum length: 120.
`result.data.data[].Cancelled_By`	`null \| object`	Yes	—	Field: Cancelled_By
`result.data.data[].$editable`	`boolean`	No	—	Field: $editable
`result.data.data[].Appointment_Name`	`string`	Yes	—	Field: Appointment_Name Maximum length: 255.
`result.data.data[].Duration`	`integer`	Yes	—	Field: Duration Format: `int32`.

The table shows the first 50 fields. Expand the raw schema 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_appointments_get_appointment_by_id --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.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation