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

> Get Associated Users Count. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Get Associated Users Count.

<Info>
  Tool ID: `zoho_crm_user_groups_get_associated_users_count`
</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_user_groups_get_associated_users_count',
  {
    "filters": "example",
    "page": 123,
    "per_page": 123
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_user_groups_get_associated_users_count --input '{
  "filters": "example",
  "page": 123,
  "per_page": 123
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "associated_users_count": [
      {
        "user_group": {
          "name": "Example",
          "id": "id_123"
        },
        "count": 123
      }
    ],
    "info": {
      "per_page": 123,
      "count": 123,
      "page": 123,
      "more_records": true
    }
  }
}
```

Use `deepline tools get zoho_crm_user_groups_get_associated_users_count --json` for the latest machine-readable contract.

## Input reference

Get the count of users associated with user groups based on the provided filters.

| Name               | Type      | Required | Default | Details                                                                       |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------- |
| `payload.filters`  | `string`  | No       | —       | Filter criteria for user groups Maximum length: 250.                          |
| `payload.page`     | `integer` | No       | —       | Page number to retrieve Format: `int32`. Minimum: 1.                          |
| `payload.per_page` | `integer` | No       | —       | Number of items to return per page Format: `int32`. Minimum: 1. Maximum: 200. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Get the count of users associated with user groups based on the provided filters.",
    "properties": {
      "filters": {
        "type": "string",
        "description": "Filter criteria for user groups",
        "maxLength": 250
      },
      "page": {
        "type": "integer",
        "description": "Page number to retrieve",
        "minimum": 1,
        "format": "int32"
      },
      "per_page": {
        "type": "integer",
        "description": "Number of items to return per page",
        "minimum": 1,
        "maximum": 200,
        "format": "int32"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                   | Type      | Required | Default | Details                                                        |
| ------------------------------------------------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `result.data`                                          | `object`  | Yes      | —       | Response containing associated users count for user groups     |
| `result.data.associated_users_count`                   | `array`   | Yes      | —       | Array of associated users count details Maximum items: 200.    |
| `result.data.associated_users_count[].user_group`      | `object`  | Yes      | —       | Details of the user group                                      |
| `result.data.associated_users_count[].user_group.name` | `string`  | Yes      | —       | Name of the user group Maximum length: 512.                    |
| `result.data.associated_users_count[].user_group.id`   | `string`  | Yes      | —       | ID of the user group Maximum length: 19.                       |
| `result.data.associated_users_count[].count`           | `integer` | Yes      | —       | Count of users associated with the user group Format: `int32`. |
| `result.data.info`                                     | `object`  | Yes      | —       | 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={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response containing associated users count for user groups",
        "properties": {
          "associated_users_count": {
            "type": "array",
            "description": "Array of associated users count details",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Associated users count details",
              "properties": {
                "user_group": {
                  "type": "object",
                  "description": "Details of the user group",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the user group",
                      "maxLength": 512
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the user group",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "count": {
                  "type": "integer",
                  "description": "Count of users associated with the user group",
                  "format": "int32"
                }
              },
              "required": [
                "user_group",
                "count"
              ],
              "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": [
          "associated_users_count",
          "info"
        ],
        "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)
