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

# Heyreach Get Workspace Users: Inputs, Cost & CLI Example

> Listing users in a specific HeyReach workspace with role and status filters. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=heyreach_get_workspace_users:{"workspace_id":"{{workspace_id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                        | Type                               | Required | Default | Description                              |
| --------------------------- | ---------------------------------- | -------- | ------- | ---------------------------------------- |
| `payload.workspace_id`      | `integer \| string`                | Yes      |         | Numeric id as integer or numeric string. |
| `payload.offset`            | `integer`                          | No       |         |                                          |
| `payload.limit`             | `integer`                          | No       |         |                                          |
| `payload.role`              | `"Admin" \| "Member" \| "Manager"` | No       |         |                                          |
| `payload.invitation_status` | `array`                            | No       |         |                                          |

### Allowed values

| Field          | Allowed values               |
| -------------- | ---------------------------- |
| `payload.role` | `Admin`, `Member`, `Manager` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "HeyReach get workspace users input.",
    "properties": {
      "workspace_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      },
      "offset": {
        "type": "integer",
        "minimum": 0
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "role": {
        "type": "string",
        "enum": [
          "Admin",
          "Member",
          "Manager"
        ]
      },
      "invitation_status": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "Unknown",
            "Pending",
            "Accepted",
            "Expired",
            "Revoked"
          ]
        }
      }
    },
    "required": [
      "workspace_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name            | Type     | Required | Default | Description |
| --------------- | -------- | -------- | ------- | ----------- |
| `result.status` | `string` | Yes      |         |             |
| `result.result` | `object` | Yes      |         |             |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "totalCount": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "workspaceId": {
                  "type": "integer"
                },
                "userDetails": {
                  "type": "object",
                  "properties": {
                    "userId": {
                      "type": "integer"
                    },
                    "name": {
                      "type": "string"
                    },
                    "surname": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  },
                  "required": [
                    "userId",
                    "name",
                    "surname",
                    "email",
                    "roles"
                  ],
                  "additionalProperties": true
                },
                "userInvitation": {
                  "type": "object",
                  "properties": {
                    "invitationId": {
                      "type": "integer"
                    },
                    "invitationStatus": {
                      "type": "string"
                    },
                    "invitationUrl": {
                      "type": "string"
                    },
                    "expirationTime": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "invitationId",
                    "invitationStatus",
                    "invitationUrl",
                    "expirationTime"
                  ],
                  "additionalProperties": true
                },
                "organizationPermissions": {
                  "type": "object",
                  "properties": {
                    "userDeactivate": {
                      "type": "boolean"
                    },
                    "manageWorkspace": {
                      "type": "boolean"
                    },
                    "manageWorkspaceMembers": {
                      "type": "boolean"
                    },
                    "viewBilling": {
                      "type": "boolean"
                    },
                    "manageBlling": {
                      "type": "boolean"
                    },
                    "manageBillingDetails": {
                      "type": "boolean"
                    },
                    "accessBillingInvoiceHistoy": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "userDeactivate",
                    "manageWorkspace",
                    "manageWorkspaceMembers",
                    "viewBilling",
                    "manageBlling",
                    "manageBillingDetails",
                    "accessBillingInvoiceHistoy"
                  ],
                  "additionalProperties": true
                },
                "workspacePermissions": {
                  "type": "object",
                  "properties": {
                    "viewLinkedInSenders": {
                      "type": "boolean"
                    },
                    "manageLinkedInSendersSettings": {
                      "type": "boolean"
                    },
                    "viewLeadLists": {
                      "type": "boolean"
                    },
                    "importEditManageLeadLists": {
                      "type": "boolean"
                    },
                    "viewMyNetwork": {
                      "type": "boolean"
                    },
                    "viewCampaigns": {
                      "type": "boolean"
                    },
                    "editManageCampaigns": {
                      "type": "boolean"
                    },
                    "viewLinkedInSenderInboxes": {
                      "type": "boolean"
                    },
                    "replyFromLinkedInSenderInboxes": {
                      "type": "boolean"
                    },
                    "viewIntegrations": {
                      "type": "boolean"
                    },
                    "manageIntegrations": {
                      "type": "boolean"
                    },
                    "exportDataToCRMs": {
                      "type": "boolean"
                    },
                    "viewNotifications": {
                      "type": "boolean"
                    },
                    "manageNotifications": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "viewLinkedInSenders",
                    "manageLinkedInSendersSettings",
                    "viewLeadLists",
                    "importEditManageLeadLists",
                    "viewMyNetwork",
                    "viewCampaigns",
                    "editManageCampaigns",
                    "viewLinkedInSenderInboxes",
                    "replyFromLinkedInSenderInboxes",
                    "viewIntegrations",
                    "manageIntegrations",
                    "exportDataToCRMs",
                    "viewNotifications",
                    "manageNotifications"
                  ],
                  "additionalProperties": true
                }
              },
              "required": [
                "workspaceId",
                "userDetails",
                "userInvitation",
                "organizationPermissions",
                "workspacePermissions"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "totalCount",
          "items"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute heyreach_get_workspace_users --payload '{
  "workspace_id": "integer"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.