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

List portal users.

<Info>
  Tool ID: `zoho_crm_portal_users_get_portal_users`
</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_portal_users_get_portal_users',
  {
    "portal": "example",
    "userType": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_portal_users_get_portal_users --input '{
  "portal": "example",
  "userType": "example"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "users": [
      {
        "personality_id": "personality_123",
        "confirm": true,
        "status_reason__s": "example",
        "created_time": "2026-01-15T12:00:00Z",
        "module": "example",
        "name": "Example",
        "active": true,
        "email": "jane.doe@example.com",
        "Source__s": "example"
      }
    ],
    "info": {
      "total_count": 123
    }
  }
}
```

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

## Input reference

Retrieve users of a specific portal filtered by user type.

| Name                | Type      | Required | Default | Details                                                    |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------- |
| `payload.portal`    | `string`  | Yes      | —       | The unique identifier of the portal Maximum length: 255.   |
| `payload.userType`  | `string`  | Yes      | —       | The type of portal user to filter by Maximum length: 255.  |
| `payload.page`      | `integer` | No       | —       | The page number to retrieve. Format: `int32`.              |
| `payload.per_page`  | `integer` | No       | —       | The number of records to return per page. Format: `int32`. |
| `payload.Source__s` | `string`  | No       | —       | The source of the user record. Maximum length: 255.        |
| `payload.filters`   | `string`  | No       | —       | The filters of the user record. Maximum length: 255.       |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieve users of a specific portal filtered by user type.",
    "properties": {
      "portal": {
        "type": "string",
        "description": "The unique identifier of the portal",
        "maxLength": 255
      },
      "userType": {
        "type": "string",
        "description": "The type of portal user to filter by",
        "maxLength": 255
      },
      "page": {
        "type": "integer",
        "description": "The page number to retrieve.",
        "format": "int32"
      },
      "per_page": {
        "type": "integer",
        "description": "The number of records to return per page.",
        "format": "int32"
      },
      "Source__s": {
        "type": "string",
        "description": "The source of the user record.",
        "maxLength": 255
      },
      "filters": {
        "type": "string",
        "description": "The filters of the user record.",
        "maxLength": 255
      }
    },
    "required": [
      "portal",
      "userType"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                   | Type      | Required | Default | Details                                                         |
| -------------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------- |
| `result.data`                          | `object`  | Yes      | —       | Response containing portal users list and metadata              |
| `result.data.users`                    | `array`   | Yes      | —       | List of portal users Maximum items: 10000.                      |
| `result.data.users[].personality_id`   | `string`  | Yes      | —       | Unique identifier for the user personality Maximum length: 255. |
| `result.data.users[].confirm`          | `boolean` | Yes      | —       | Confirmation status of the user                                 |
| `result.data.users[].status_reason__s` | `string`  | Yes      | —       | Reason for the current status Maximum length: 500.              |
| `result.data.users[].created_time`     | `string`  | Yes      | —       | Timestamp when the user was created Format: `date-time`.        |
| `result.data.users[].module`           | `string`  | Yes      | —       | Module associated with the user Maximum length: 100.            |
| `result.data.users[].name`             | `string`  | Yes      | —       | Name of the portal user Maximum length: 255.                    |
| `result.data.users[].active`           | `boolean` | Yes      | —       | Indicates if the user is active                                 |
| `result.data.users[].email`            | `string`  | Yes      | —       | Email address of the user Format: `email`.                      |
| `result.data.users[].Source__s`        | `string`  | Yes      | —       | Source of the user record Maximum length: 255.                  |
| `result.data.info`                     | `object`  | Yes      | —       | Metadata about the response                                     |
| `result.data.info.total_count`         | `integer` | Yes      | —       | Total number of users Format: `int32`.                          |
| `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 portal users list and metadata",
        "properties": {
          "users": {
            "type": "array",
            "description": "List of portal users",
            "maxItems": 10000,
            "items": {
              "type": "object",
              "description": "Portal user details",
              "properties": {
                "personality_id": {
                  "type": "string",
                  "description": "Unique identifier for the user personality",
                  "maxLength": 255
                },
                "confirm": {
                  "type": "boolean",
                  "description": "Confirmation status of the user"
                },
                "status_reason__s": {
                  "type": "string",
                  "description": "Reason for the current status",
                  "maxLength": 500
                },
                "created_time": {
                  "type": "string",
                  "description": "Timestamp when the user was created",
                  "format": "date-time"
                },
                "module": {
                  "type": "string",
                  "description": "Module associated with the user",
                  "maxLength": 100
                },
                "name": {
                  "type": "string",
                  "description": "Name of the portal user",
                  "maxLength": 255
                },
                "active": {
                  "type": "boolean",
                  "description": "Indicates if the user is active"
                },
                "email": {
                  "type": "string",
                  "description": "Email address of the user",
                  "format": "email"
                },
                "Source__s": {
                  "type": "string",
                  "description": "Source of the user record",
                  "maxLength": 255
                }
              },
              "required": [
                "personality_id",
                "confirm",
                "status_reason__s",
                "created_time",
                "module",
                "name",
                "active",
                "email",
                "Source__s"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Metadata about the response",
            "properties": {
              "total_count": {
                "type": "integer",
                "description": "Total number of users",
                "format": "int32"
              }
            },
            "required": [
              "total_count"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "users",
          "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)