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

# Salesforge Get Workspaces Workspaceid Mailboxes: Inputs,

> Get mailboxes. Salesforge Salesforge Get Workspaces Workspaceid Mailboxes docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## 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=salesforge_get_workspaces_workspaceid_mailboxes:{"workspaceID":"{{workspaceID}}"}' --json
```

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

## Input Schema

| Name                           | Type                                                                                             | Required | Default | Description                 |
| ------------------------------ | ------------------------------------------------------------------------------------------------ | -------- | ------- | --------------------------- |
| `payload.workspaceID`          | `string`                                                                                         | Yes      |         | Workspace ID                |
| `payload.limit`                | `integer`                                                                                        | No       | `10`    | Limit                       |
| `payload.offset`               | `integer`                                                                                        | No       | `0`     | Offset                      |
| `payload.statuses`             | `array`                                                                                          | No       |         | Filter by status            |
| `payload.mailbox_ids`          | `array`                                                                                          | No       |         | Filter by mailbox IDs       |
| `payload.excluded_mailbox_ids` | `array`                                                                                          | No       |         | Exclude mailbox IDs         |
| `payload.search`               | `string`                                                                                         | No       |         | Search query                |
| `payload.tag_ids`              | `array`                                                                                          | No       |         | Filter by tag IDs           |
| `payload.not_tag_ids`          | `array`                                                                                          | No       |         | Exclude tag IDs             |
| `payload.addresses`            | `array`                                                                                          | No       |         | Filter by mailbox addresses |
| `payload.status_criteria`      | `"all" \| "active" \| "warm" \| "pending" \| "suspended" \| "disconnected" \| "recommendations"` | No       | `"all"` | Status criteria             |
| `payload.statuses_criteria`    | `array`                                                                                          | No       | `"all"` | Statuses criteria           |

### Allowed values

| Field                     | Allowed values                                                                     |
| ------------------------- | ---------------------------------------------------------------------------------- |
| `payload.status_criteria` | `all`, `active`, `warm`, `pending`, `suspended`, `disconnected`, `recommendations` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Get mailboxes associated with the workspace.",
    "properties": {
      "workspaceID": {
        "type": "string",
        "description": "Workspace ID"
      },
      "limit": {
        "type": "integer",
        "description": "Limit",
        "default": 10
      },
      "offset": {
        "type": "integer",
        "description": "Offset",
        "default": 0
      },
      "statuses": {
        "type": "array",
        "description": "Filter by status",
        "items": {
          "type": "string",
          "enum": [
            "active",
            "access_lost",
            "pending"
          ]
        }
      },
      "mailbox_ids": {
        "type": "array",
        "description": "Filter by mailbox IDs",
        "items": {
          "type": "string"
        }
      },
      "excluded_mailbox_ids": {
        "type": "array",
        "description": "Exclude mailbox IDs",
        "items": {
          "type": "string"
        }
      },
      "search": {
        "type": "string",
        "description": "Search query"
      },
      "tag_ids": {
        "type": "array",
        "description": "Filter by tag IDs",
        "items": {
          "type": "string"
        }
      },
      "not_tag_ids": {
        "type": "array",
        "description": "Exclude tag IDs",
        "items": {
          "type": "string"
        }
      },
      "addresses": {
        "type": "array",
        "description": "Filter by mailbox addresses",
        "items": {
          "type": "string"
        }
      },
      "status_criteria": {
        "type": "string",
        "description": "Status criteria",
        "default": "all",
        "enum": [
          "all",
          "active",
          "warm",
          "pending",
          "suspended",
          "disconnected",
          "recommendations"
        ]
      },
      "statuses_criteria": {
        "type": "array",
        "description": "Statuses criteria",
        "default": "all",
        "items": {
          "type": "string",
          "enum": [
            "all",
            "active",
            "warm",
            "pending",
            "suspended",
            "disconnected",
            "recommendations"
          ]
        }
      }
    },
    "required": [
      "workspaceID"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `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": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "createdAt": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "email",
                    "domain",
                    "linkedin"
                  ]
                },
                "value": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

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

```bash theme={null}
deepline tools execute salesforge_get_workspaces_workspaceid_mailboxes --payload '{
  "workspaceID": "string"
}' --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`.