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

> Listing all workspaces in a HeyReach organization. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Listing all workspaces in a HeyReach organization.

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

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_all_workspaces --input '{
  "offset": 123,
  "limit": 100
}' --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"]}}
{
  "status": "example",
  "result": {
    "totalCount": 123,
    "items": [
      {
        "workspaceId": 123,
        "workspaceName": "Example",
        "seatsLimit": 123,
        "usedSeats": 123
      }
    ]
  }
}
```

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

## Input reference

HeyReach get all workspaces input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.offset` | `integer` | No | — | Minimum: 0. |
| `payload.limit` | `integer` | No | — | Minimum: 1. Maximum: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get all workspaces input.",
    "properties": {
      "offset": {
        "type": "integer",
        "minimum": 0
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    },
    "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[].workspaceId` | `integer` | Yes | — | — |
| `result.result.items[].workspaceName` | `string` | Yes | — | — |
| `result.result.items[].seatsLimit` | `integer` | Yes | — | — |
| `result.result.items[].usedSeats` | `integer` | 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": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "workspaceId": {
                      "type": "integer"
                    },
                    "workspaceName": {
                      "type": "string"
                    },
                    "seatsLimit": {
                      "type": "integer"
                    },
                    "usedSeats": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "workspaceId",
                    "workspaceName",
                    "seatsLimit",
                    "usedSeats"
                  ],
                  "additionalProperties": true
                },
                {
                  "type": "object",
                  "properties": {
                    "workspaceId": {
                      "type": "integer"
                    },
                    "workspaceName": {
                      "type": "string"
                    },
                    "seatsLimit": {
                      "type": "integer"
                    },
                    "usedSeats": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "workspaceId",
                    "workspaceName",
                    "seatsLimit",
                    "usedSeats"
                  ],
                  "additionalProperties": true
                },
                {
                  "type": "object",
                  "properties": {
                    "workspaceId": {
                      "type": "integer"
                    },
                    "workspaceName": {
                      "type": "string"
                    },
                    "seatsLimit": {
                      "type": "null"
                    },
                    "usedSeats": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "workspaceId",
                    "workspaceName",
                    "seatsLimit",
                    "usedSeats"
                  ],
                  "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.