> ## 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: README

> List available REST APIs. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

List available REST APIs.

<Info>
  Tool ID: `zoho_crm_apis_get_available_apis`
</Info>

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

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_apis_get_available_apis',
  {
    "filters": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute zoho_crm_apis_get_available_apis --input '{
  "filters": "example"
}' --json
```

## Example response

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

## Input reference

Returns the list of available REST API endpoints, grouped by module and feature, that the current user can access in this tenant.

| Name              | Type     | Required | Default | Details                                           |
| ----------------- | -------- | -------- | ------- | ------------------------------------------------- |
| `payload.filters` | `string` | No       | —       | Filter APIs by OAuth scope. Maximum length: 2048. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Returns the list of available REST API endpoints, grouped by module and feature, that the current user can access in this tenant.",
    "properties": {
      "filters": {
        "type": "string",
        "description": "Filter APIs by OAuth scope.",
        "maxLength": 2048
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                 | Type                                              | Required | Default | Details                                                                        |
| ---------------------------------------------------- | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------ |
| `result.data`                                        | `object`                                          | Yes      | —       | List of available REST APIs and their operation types.                         |
| `result.data.__apis`                                 | `array`                                           | Yes      | —       | Available API entries. Maximum items: 2000.                                    |
| `result.data.__apis[].path`                          | `string`                                          | Yes      | —       | Absolute API path under /crm/v8 with templated variables. Maximum length: 512. |
| `result.data.__apis[].operation_types`               | `array`                                           | Yes      | —       | Supported HTTP operations for the path. Maximum items: 10.                     |
| `result.data.__apis[].operation_types[].method`      | `"GET" \| "POST" \| "PUT" \| "PATCH" \| "DELETE"` | Yes      | —       | HTTP method. Allowed: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.                 |
| `result.data.__apis[].operation_types[].oauth_scope` | `string`                                          | Yes      | —       | Required OAuth scope for the operation. Maximum length: 128.                   |
| `result.data.__apis[].operation_types[].max_credits` | `integer`                                         | Yes      | —       | Maximum credits consumed per request. Format: `int32`. Minimum: 0.             |
| `result.data.__apis[].operation_types[].min_credits` | `integer`                                         | Yes      | —       | Minimum credits consumed per request. Format: `int32`. Minimum: 0.             |
| `result.meta`                                        | `object`                                          | No       | —       | Additional response metadata (status, paging).                                 |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "List of available REST APIs and their operation types.",
        "properties": {
          "__apis": {
            "type": "array",
            "description": "Available API entries.",
            "maxItems": 2000,
            "items": {
              "type": "object",
              "description": "Single API entry with path and supported operations.",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "Absolute API path under /crm/v8 with templated variables.",
                  "maxLength": 512
                },
                "operation_types": {
                  "type": "array",
                  "description": "Supported HTTP operations for the path.",
                  "maxItems": 10,
                  "items": {
                    "type": "object",
                    "description": "Operation descriptor.",
                    "properties": {
                      "method": {
                        "type": "string",
                        "description": "HTTP method.",
                        "enum": [
                          "GET",
                          "POST",
                          "PUT",
                          "PATCH",
                          "DELETE"
                        ]
                      },
                      "oauth_scope": {
                        "type": "string",
                        "description": "Required OAuth scope for the operation.",
                        "maxLength": 128
                      },
                      "max_credits": {
                        "type": "integer",
                        "description": "Maximum credits consumed per request.",
                        "minimum": 0,
                        "format": "int32"
                      },
                      "min_credits": {
                        "type": "integer",
                        "description": "Minimum credits consumed per request.",
                        "minimum": 0,
                        "format": "int32"
                      }
                    },
                    "required": [
                      "method",
                      "oauth_scope",
                      "max_credits",
                      "min_credits"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "path",
                "operation_types"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "__apis"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)