> ## 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 CRM profiles. Zoho CRM Profiles Get Profiles reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

List CRM profiles.

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

## Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example.

Inspect the live contract before executing it:

```bash theme={null}
deepline tools get zoho_crm_profiles_get_profiles --json
```

## Example response

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

## Input reference

Retrieves the list of CRM profiles with metadata. **Scopes:** \* ZohoCRM.settings.profiles.all \* ZohoCRM.settings.profiles.read

| Name                    | Type                                    | Required | Default | Details                                                                                                                                                                                    |
| ----------------------- | --------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `payload.type`          | `"private_profile" \| "normal_profile"` | No       | —       | Filter profiles by type. Allowed: `private_profile`, `normal_profile`.                                                                                                                     |
| `payload.include_types` | `string`                                | No       | —       | Comma-separated list to include additional profile types along with Administrator, Standard, and all custom profiles. Maximum length: 50. Pattern: `^(Lite\|Support)(,(Lite\|Support))*$`. |
| `payload.filters`       | `unknown`                               | No       | —       | JSON-encoded filters to apply when listing profiles.                                                                                                                                       |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves the list of CRM profiles with metadata. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read",
    "properties": {
      "type": {
        "type": "string",
        "description": "Filter profiles by type.",
        "enum": [
          "private_profile",
          "normal_profile"
        ]
      },
      "include_types": {
        "type": "string",
        "description": "Comma-separated list to include additional profile types along with Administrator, Standard, and all custom profiles.",
        "maxLength": 50,
        "pattern": "^(Lite|Support)(,(Lite|Support))*$"
      },
      "filters": {
        "description": "JSON-encoded filters to apply when listing profiles."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                                 | Type                                                                          | Required | Default | Details                                                                                                                                                                                    |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `result.data`                                                        | `object`                                                                      | Yes      | —       | Profiles collection response.                                                                                                                                                              |
| `result.data.profiles`                                               | `array`                                                                       | Yes      | —       | List of profiles. Maximum items: 200.                                                                                                                                                      |
| `result.data.profiles[].api_name`                                    | `string`                                                                      | Yes      | —       | API name of the profile. API identifier using alphanumeric characters and underscores, must start with a letter Minimum length: 1. Maximum length: 50. Pattern: `^[A-Za-z][A-Za-z0-9_]*$`. |
| `result.data.profiles[].id`                                          | `string`                                                                      | Yes      | —       | Unique identifier (64-bit integer represented as string) Format: `int64`. Minimum length: 1. Maximum length: 19. Pattern: `^[0-9]&#123;1,19&#125;$`.                                       |
| `result.data.profiles[].created_time`                                | `record`                                                                      | Yes      | —       | —                                                                                                                                                                                          |
| `result.data.profiles[].modified_time`                               | `record`                                                                      | Yes      | —       | —                                                                                                                                                                                          |
| `result.data.profiles[].name`                                        | `string`                                                                      | Yes      | —       | profile name Minimum length: 1. Maximum length: 50. Pattern: `^[^~`#%^&\*()+\|,=\{};\[]"]+\$\`.                                                                                            |
| `result.data.profiles[].display_label`                               | `string`                                                                      | Yes      | —       | Display label for the profile. Maximum length: 255.                                                                                                                                        |
| `result.data.profiles[].modified_by`                                 | `record`                                                                      | No       | —       | —                                                                                                                                                                                          |
| `result.data.profiles[].description`                                 | `string \| null`                                                              | No       | —       | Profile description. Maximum length: 255.                                                                                                                                                  |
| `result.data.profiles[].created_by`                                  | `record`                                                                      | No       | —       | —                                                                                                                                                                                          |
| `result.data.profiles[].custom`                                      | `boolean`                                                                     | Yes      | —       | Indicates if the profile is custom.                                                                                                                                                        |
| `result.data.profiles[].type`                                        | `"private_profile" \| "normal_profile" \| "lite_profile" \| "system_profile"` | Yes      | —       | Profile type. Allowed: `private_profile`, `normal_profile`, `lite_profile`, `system_profile`.                                                                                              |
| `result.data.profiles[].permissions_details`                         | `array`                                                                       | No       | —       | Permission details for the profile. Maximum items: 1000.                                                                                                                                   |
| `result.data.profiles[].permissions_details[].display_label`         | `string`                                                                      | No       | —       | Permission display label. Maximum length: 255.                                                                                                                                             |
| `result.data.profiles[].permissions_details[].module`                | `object \| null`                                                              | No       | —       | Associated module for the permission.                                                                                                                                                      |
| `result.data.profiles[].permissions_details[].name`                  | `string`                                                                      | No       | —       | Permission name. Maximum length: 255.                                                                                                                                                      |
| `result.data.profiles[].permissions_details[].customizable`          | `boolean`                                                                     | No       | —       | Whether the permission is customizable.                                                                                                                                                    |
| `result.data.profiles[].permissions_details[].id`                    | `string`                                                                      | No       | —       | Unique identifier (64-bit integer represented as string) Format: `int64`. Minimum length: 1. Maximum length: 19. Pattern: `^[0-9]&#123;1,19&#125;$`.                                       |
| `result.data.profiles[].permissions_details[].enabled`               | `boolean`                                                                     | No       | —       | Whether the permission is enabled.                                                                                                                                                         |
| `result.data.profiles[].permissions_details[].tooltip_msg`           | `string`                                                                      | No       | —       | Tooltip message for the permission. Maximum length: 500.                                                                                                                                   |
| `result.data.profiles[].permissions_details[].parent_permissions`    | `array`                                                                       | No       | —       | Parent permissions applicable to this permission. Maximum items: 100.                                                                                                                      |
| `result.data.profiles[].sections`                                    | `array`                                                                       | No       | —       | Sections grouping category permissions. Maximum items: 100.                                                                                                                                |
| `result.data.profiles[].sections[].name`                             | `string`                                                                      | Yes      | —       | Section name. Maximum length: 255.                                                                                                                                                         |
| `result.data.profiles[].sections[].categories`                       | `array`                                                                       | Yes      | —       | Categories within the section. Maximum items: 100.                                                                                                                                         |
| `result.data.profiles[].sections[].categories[].display_label`       | `string`                                                                      | Yes      | —       | Category display label. Maximum length: 255.                                                                                                                                               |
| `result.data.profiles[].sections[].categories[].permissions_details` | `array`                                                                       | Yes      | —       | Permissions under the category. Maximum items: 500.                                                                                                                                        |
| `result.data.profiles[].sections[].categories[].name`                | `string`                                                                      | Yes      | —       | Category name. Maximum length: 255.                                                                                                                                                        |
| `result.data.profiles[].sections[].categories[].module`              | `object \| null`                                                              | No       | —       | Associated module for the category.                                                                                                                                                        |
| `result.data.info`                                                   | `record`                                                                      | No       | —       | —                                                                                                                                                                                          |
| `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": "Profiles collection response.",
        "properties": {
          "profiles": {
            "type": "array",
            "description": "List of profiles.",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Profile details.",
              "properties": {
                "api_name": {
                  "type": "string",
                  "description": "API name of the profile. API identifier using alphanumeric characters and underscores, must start with a letter",
                  "minLength": 1,
                  "maxLength": 50,
                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier (64-bit integer represented as string)",
                  "minLength": 1,
                  "maxLength": 19,
                  "pattern": "^[0-9]{1,19}$",
                  "format": "int64"
                },
                "created_time": {
                  "type": "object",
                  "additionalProperties": true
                },
                "modified_time": {
                  "type": "object",
                  "additionalProperties": true
                },
                "name": {
                  "type": "string",
                  "description": "profile name",
                  "minLength": 1,
                  "maxLength": 50,
                  "pattern": "^[^~`#%^&*()+|,={};\\[\\]\"]+$"
                },
                "display_label": {
                  "type": "string",
                  "description": "Display label for the profile.",
                  "maxLength": 255
                },
                "modified_by": {
                  "type": "object",
                  "additionalProperties": true
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Profile description.",
                  "maxLength": 255
                },
                "created_by": {
                  "type": "object",
                  "additionalProperties": true
                },
                "custom": {
                  "type": "boolean",
                  "description": "Indicates if the profile is custom."
                },
                "type": {
                  "type": "string",
                  "description": "Profile type.",
                  "enum": [
                    "private_profile",
                    "normal_profile",
                    "lite_profile",
                    "system_profile"
                  ]
                },
                "permissions_details": {
                  "type": "array",
                  "description": "Permission details for the profile.",
                  "maxItems": 1000,
                  "items": {
                    "type": "object",
                    "description": "Permission detail entry.",
                    "properties": {
                      "display_label": {
                        "type": "string",
                        "description": "Permission display label.",
                        "maxLength": 255
                      },
                      "module": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "description": "Associated module for the permission.",
                        "additionalProperties": false
                      },
                      "name": {
                        "type": "string",
                        "description": "Permission name.",
                        "maxLength": 255
                      },
                      "customizable": {
                        "type": "boolean",
                        "description": "Whether the permission is customizable."
                      },
                      "id": {
                        "type": "string",
                        "description": "Unique identifier (64-bit integer represented as string)",
                        "minLength": 1,
                        "maxLength": 19,
                        "pattern": "^[0-9]{1,19}$",
                        "format": "int64"
                      },
                      "enabled": {
                        "type": "boolean",
                        "description": "Whether the permission is enabled."
                      },
                      "tooltip_msg": {
                        "type": "string",
                        "description": "Tooltip message for the permission.",
                        "maxLength": 500
                      },
                      "parent_permissions": {
                        "type": "array",
                        "description": "Parent permissions applicable to this permission.",
                        "maxItems": 100,
                        "items": {
                          "type": "string",
                          "description": "Parent permission identifier.",
                          "maxLength": 255
                        }
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "sections": {
                  "type": "array",
                  "description": "Sections grouping category permissions.",
                  "maxItems": 100,
                  "items": {
                    "type": "object",
                    "description": "Section entry.",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Section name.",
                        "maxLength": 255
                      },
                      "categories": {
                        "type": "array",
                        "description": "Categories within the section.",
                        "maxItems": 100,
                        "items": {
                          "type": "object",
                          "description": "Category entry.",
                          "properties": {
                            "display_label": {
                              "type": "string",
                              "description": "Category display label.",
                              "maxLength": 255
                            },
                            "permissions_details": {
                              "type": "array",
                              "description": "Permissions under the category.",
                              "maxItems": 500,
                              "items": {
                                "type": "string",
                                "description": "Permission identifier.",
                                "maxLength": 255
                              }
                            },
                            "name": {
                              "type": "string",
                              "description": "Category name.",
                              "maxLength": 255
                            },
                            "module": {
                              "type": [
                                "object",
                                "null"
                              ],
                              "description": "Associated module for the category.",
                              "additionalProperties": false
                            }
                          },
                          "required": [
                            "display_label",
                            "permissions_details",
                            "name"
                          ],
                          "additionalProperties": false
                        }
                      }
                    },
                    "required": [
                      "name",
                      "categories"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "api_name",
                "id",
                "created_time",
                "modified_time",
                "name",
                "display_label",
                "custom",
                "type"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "required": [
          "profiles"
        ],
        "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)
