Zoho: Get an Appointment Record by ID

← Appointments operations · Get started

Operation zoho.getappointmentbyid

Provider route: GET /crm/v8/Appointments__s/{appointmentId}. Alter supplies the connection’s credentials and routing.

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["appointments"]["getAppointmentById"]>[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.appointments.getAppointmentById(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.appointments.get_appointment_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.appointmentId	string	Required within parent	Maximum length: 100

Response

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

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Appointment Records — response body

Referenced models: Get Appointment Records — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Get Appointment Records — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the request to retrieve appointment records, containing the list of appointment objects. Additional keys: allowed
data	array	Required within parent	Represents the list of appointment records returned by the GET request. Maximum items: 200 Minimum items: 1
data[]	Model	Each item	Expand Get Appointment Records — response body — data item

Referenced models: Get Appointment Records — response body — data item

Get Appointment Records — response body — data item Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user who created the appointment record. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user who created the record. Maximum length: 255
name	string	Required within parent	Represents the full name of the user who created the record. Maximum length: 255

Get Appointment Records — response body — data item Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user who last modified the appointment record. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user who last modified the record. Maximum length: 255
name	string	Required within parent	Represents the full name of the user who last modified the record. Maximum length: 255

Get Appointment Records — response body — data item Owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the service member assigned as the appointment owner, including the user ID, full name, and email address. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the appointment owner. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the appointment owner. Maximum length: 255
name	string	Required within parent	Represents the full name of the appointment owner. Maximum length: 255

Get Appointment Records — response body — data item Appointment For

Field	Type	Presence	Description and constraints
$	object	Root	Represents the customer for whom the appointment was created, including the record ID, name, and module information. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the customer record. Maximum length: 255
module	Model	Required within parent	Expand Get Appointment Records — response body — data item Appointment For module
name	string	Required within parent	Represents the full name of the customer. Maximum length: 255

Referenced models: Get Appointment Records — response body — data item Appointment For module

Get Appointment Records — response body — data item Service Name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the service for which the appointment was created, including the service ID and name. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the service. Maximum length: 255
name	string	Required within parent	Represents the name of the service for which the appointment was created. Maximum length: 255

Get Appointment Records — response body — data item Remind At null item

Field	Type	Presence	Description and constraints
$	JSON	Root	Each object represents a single reminder configuration, including the time unit and numeric value.
period	string	Optional	Represents the unit of time for the reminder. **Possible values**: - minutes - The reminder is sent a specified number of minutes before the appointment. - hours - The reminder is sent a specified number of hours before the appointment. - days - The reminder is sent a specified number of days before the appointment. Known values: minutes, hours, days
unit	JSON	Optional
unit (anyOf 1)	integer	Alternative	Represents the numeric value of the reminder time. The value of a unit key can be only from **0 to 100**. Format: int32
unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Appointment Records — response body — data item Appointment For module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the Appointment_For customer record, including the module API name and ID. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the module for the customer record. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the module. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getappointmentbyid. Catalog operation: getAppointmentById. 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.

Official provider source