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

> Listing all users in a HeyReach organization with role and status filters. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Listing all users in a HeyReach organization with role and status filters.

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

## 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(
  'heyreach_get_all_users',
  {
    "offset": 123,
    "limit": 100,
    "role": "Admin"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_all_users --input '{
  "offset": 123,
  "limit": 100,
  "role": "Admin"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe heyreach_get_all_users --json` for the complete live contract.

## Input reference

HeyReach get all users input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.offset` | `integer` | No | — | Minimum: 0. |
| `payload.limit` | `integer` | No | — | Minimum: 1. Maximum: 100. |
| `payload.role` | `"Admin" \| "Member" \| "Manager"` | No | — | Allowed: `Admin`, `Member`, `Manager`. |
| `payload.invitation_status` | `array` | No | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get all users input.",
    "properties": {
      "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"
          ]
        }
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.totalCount` | `integer` | Yes | — | — |
| `result.result.items` | `array` | Yes | — | — |
| `result.result.items[].userDetails` | `object` | Yes | — | — |
| `result.result.items[].userDetails.userId` | `integer` | Yes | — | — |
| `result.result.items[].userDetails.name` | `string` | Yes | — | — |
| `result.result.items[].userDetails.surname` | `string` | Yes | — | — |
| `result.result.items[].userDetails.email` | `string` | Yes | — | — |
| `result.result.items[].userDetails.roles` | `array` | Yes | — | — |
| `result.result.items[].userInvitation` | `object` | Yes | — | — |
| `result.result.items[].userInvitation.invitationId` | `integer` | Yes | — | — |
| `result.result.items[].userInvitation.invitationStatus` | `string` | Yes | — | — |
| `result.result.items[].userInvitation.invitationUrl` | `string` | Yes | — | — |
| `result.result.items[].userInvitation.expirationTime` | `string` | Yes | — | — |
| `result.result.items[].organizationPermissions` | `object` | Yes | — | — |
| `result.result.items[].organizationPermissions.userDeactivate` | `boolean` | Yes | — | — |
| `result.result.items[].organizationPermissions.manageWorkspace` | `boolean` | Yes | — | — |
| `result.result.items[].organizationPermissions.manageWorkspaceMembers` | `boolean` | Yes | — | — |
| `result.result.items[].organizationPermissions.viewBilling` | `boolean` | Yes | — | — |
| `result.result.items[].organizationPermissions.manageBlling` | `boolean` | Yes | — | — |
| `result.result.items[].organizationPermissions.manageBillingDetails` | `boolean` | Yes | — | — |
| `result.result.items[].organizationPermissions.accessBillingInvoiceHistoy` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions` | `array` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].workspaceName` | `string` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].workspaceId` | `integer` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions` | `object` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewLinkedInSenders` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.manageLinkedInSendersSettings` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewLeadLists` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.importEditManageLeadLists` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewMyNetwork` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewCampaigns` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.editManageCampaigns` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewLinkedInSenderInboxes` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.replyFromLinkedInSenderInboxes` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewIntegrations` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.manageIntegrations` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.exportDataToCRMs` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.viewNotifications` | `boolean` | Yes | — | — |
| `result.result.items[].workspacesPermissions[].permissions.manageNotifications` | `boolean` | Yes | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "totalCount": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "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
                },
                "workspacesPermissions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "workspaceName": {
                        "type": "string"
                      },
                      "workspaceId": {
                        "type": "integer"
                      },
                      "permissions": {
                        "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": [
                      "workspaceName",
                      "workspaceId",
                      "permissions"
                    ],
                    "additionalProperties": true
                  }
                }
              },
              "required": [
                "userDetails",
                "userInvitation",
                "organizationPermissions",
                "workspacesPermissions"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "totalCount",
          "items"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</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

* [HeyReach provider guide](https://deepline.com/docs/providers/heyreach/guide.md)
* [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.