> ## 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: User Groups Get Group

> Get one Zoho CRM user group, with its name, description and members. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one Zoho CRM user group, with its name, description and members.

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

## 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_user_groups_get_group',
  {
    "group": "1234567890"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_user_groups_get_group --input '{
  "group": "1234567890"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "user_groups": [
      {
        "created_by": {
          "name": "Example",
          "id": "id_123"
        },
        "modified_by": {},
        "modified_time": {},
        "created_time": "2026-01-15T12:00:00Z",
        "description": {},
        "id": "id_123",
        "name": "Example"
      }
    ]
  }
}
```

Use `deepline describe zoho_crm_user_groups_get_group --json` for the latest machine-readable contract.

## Input reference

Get details of the specified user group.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.group` | `"1234567890"` | Yes | — | The unique identifier of the user group Allowed: `1234567890`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get details of the specified user group.",
    "properties": {
      "group": {
        "type": "string",
        "description": "The unique identifier of the user group",
        "enum": [
          "1234567890"
        ]
      }
    },
    "required": [
      "group"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response containing list of user groups |
| `result.data.user_groups` | `array` | Yes | — | Array of user groups Maximum items: 200. |
| `result.data.user_groups[].created_by` | `object` | Yes | — | User who created this group |
| `result.data.user_groups[].created_by.name` | `string` | Yes | — | Name of the creator Maximum length: 512. |
| `result.data.user_groups[].created_by.id` | `string` | Yes | — | ID of the creator Maximum length: 19. |
| `result.data.user_groups[].modified_by` | `record` | Yes | — | User who last modified this group |
| `result.data.user_groups[].modified_time` | `record` | Yes | — | Last modification timestamp |
| `result.data.user_groups[].created_time` | `string` | Yes | — | Creation timestamp Format: `date-time`. |
| `result.data.user_groups[].description` | `record` | Yes | — | Group description |
| `result.data.user_groups[].id` | `string` | Yes | — | Unique identifier for the group Maximum length: 19. |
| `result.data.user_groups[].name` | `string` | Yes | — | Name of the group Maximum length: 250. |
| `result.data.user_groups[].sources_count` | `object` | No | — | Count of sources by type |
| `result.data.user_groups[].sources_count.territories` | `integer` | No | — | Number of territories Format: `int32`. |
| `result.data.user_groups[].sources_count.roles` | `integer` | No | — | Number of roles Format: `int32`. |
| `result.data.user_groups[].sources_count.groups` | `integer` | No | — | Number of groups Format: `int32`. |
| `result.data.user_groups[].sources_count.users` | `object` | No | — | User count by status |
| `result.data.user_groups[].sources_count.users.inactive` | `integer` | Yes | — | Number of inactive users Format: `int32`. |
| `result.data.user_groups[].sources_count.users.deleted` | `integer` | Yes | — | Number of deleted users Format: `int32`. |
| `result.data.user_groups[].sources_count.users.active` | `integer` | Yes | — | Number of active users Format: `int32`. |
| `result.data.info` | `object` | No | — | Information about pagination |
| `result.data.info.per_page` | `integer` | Yes | — | Number of records per page Format: `int32`. |
| `result.data.info.count` | `integer` | Yes | — | Number of records Format: `int32`. |
| `result.data.info.page` | `integer` | Yes | — | Current page number Format: `int32`. |
| `result.data.info.more_records` | `boolean` | Yes | — | Indicates if there are more records available |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response containing list of user groups",
        "properties": {
          "user_groups": {
            "type": "array",
            "description": "Array of user groups",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "User group details",
              "properties": {
                "created_by": {
                  "type": "object",
                  "description": "User who created this group",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the creator",
                      "maxLength": 512
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the creator",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "modified_by": {
                  "type": "object",
                  "description": "User who last modified this group",
                  "additionalProperties": true
                },
                "modified_time": {
                  "type": "object",
                  "description": "Last modification timestamp",
                  "additionalProperties": true
                },
                "created_time": {
                  "type": "string",
                  "description": "Creation timestamp",
                  "format": "date-time"
                },
                "description": {
                  "type": "object",
                  "description": "Group description",
                  "additionalProperties": true
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the group",
                  "maxLength": 19
                },
                "name": {
                  "type": "string",
                  "description": "Name of the group",
                  "maxLength": 250
                },
                "sources_count": {
                  "type": "object",
                  "description": "Count of sources by type",
                  "properties": {
                    "territories": {
                      "type": "integer",
                      "description": "Number of territories",
                      "format": "int32"
                    },
                    "roles": {
                      "type": "integer",
                      "description": "Number of roles",
                      "format": "int32"
                    },
                    "groups": {
                      "type": "integer",
                      "description": "Number of groups",
                      "format": "int32"
                    },
                    "users": {
                      "type": "object",
                      "description": "User count by status",
                      "properties": {
                        "inactive": {
                          "type": "integer",
                          "description": "Number of inactive users",
                          "format": "int32"
                        },
                        "deleted": {
                          "type": "integer",
                          "description": "Number of deleted users",
                          "format": "int32"
                        },
                        "active": {
                          "type": "integer",
                          "description": "Number of active users",
                          "format": "int32"
                        }
                      },
                      "required": [
                        "inactive",
                        "deleted",
                        "active"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                }
              },
              "required": [
                "created_by",
                "modified_by",
                "modified_time",
                "created_time",
                "description",
                "id",
                "name"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Information about pagination",
            "properties": {
              "per_page": {
                "type": "integer",
                "description": "Number of records per page",
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Number of records",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "description": "Current page number",
                "format": "int32"
              },
              "more_records": {
                "type": "boolean",
                "description": "Indicates if there are more records available"
              }
            },
            "required": [
              "per_page",
              "count",
              "page",
              "more_records"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "user_groups"
        ],
        "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](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.