> ## 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: Appointments Get Appointment By ID

> Get one Zoho CRM appointment by its ID, with its details. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one Zoho CRM appointment by its ID, with its details.

> [!NOTE]
>
> Tool ID: `zoho_crm_appointments_get_appointment_by_id`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_appointments_get_appointment_by_id --input '{
  "appointmentId": "appointment_123"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe 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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "appointment mode record get by id",
    "properties": {
      "appointmentId": {
        "type": "string",
        "description": "Path parameter: appointmentId",
        "maxLength": 100
      }
    },
    "required": [
      "appointmentId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe 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.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.