> ## 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 Primebox Labels

> List the inbox (Primebox) labels in a Salesforge workspace. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the inbox (Primebox) labels in a Salesforge workspace.

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

## 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(
  'salesforge_get_workspaces_workspaceid_primebox_labels',
  {
    "workspaceID": "workspace_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesforge_get_workspaces_workspaceid_primebox_labels --input '{
  "workspaceID": "workspace_123"
}' --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"]}}
{
  "data": {
    "data": [
      {
        "id": "id_123",
        "isBuiltIn": true,
        "name": "Example"
      }
    ],
    "limit": 123,
    "offset": 123
  }
}
```

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

## Input reference

Get a paginated list of primebox labels associated with the workspace.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspaceID` | `string` | Yes | — | Workspace ID |
| `payload.limit` | `integer` | No | `10` | Limit |
| `payload.offset` | `integer` | No | `0` | Offset |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get a paginated list of primebox labels 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
      }
    },
    "required": [
      "workspaceID"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].id` | `string` | No | — | — |
| `result.data.data[].isBuiltIn` | `boolean` | No | — | — |
| `result.data.data[].name` | `string` | No | — | — |
| `result.data.data[].specialLabel` | `"all" \| "none" \| "positive" \| "negative" \| "ooo" \| "meeting_booked" \| "meeting_completed" \| "closed" \| "wrong_contact"` | No | — | Allowed: `all`, `none`, `positive`, `negative`, `ooo`, `meeting_booked`, `meeting_completed`, `closed`, `wrong_contact`. |
| `result.data.limit` | `integer` | No | — | — |
| `result.data.offset` | `integer` | No | — | — |
| `result.data.total` | `integer` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "uniqueItems": false,
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "isBuiltIn": {
                  "type": "boolean"
                },
                "name": {
                  "type": "string"
                },
                "specialLabel": {
                  "type": "string",
                  "enum": [
                    "all",
                    "none",
                    "positive",
                    "negative",
                    "ooo",
                    "meeting_booked",
                    "meeting_completed",
                    "closed",
                    "wrong_contact"
                  ]
                }
              },
              "additionalProperties": false
            }
          },
          "limit": {
            "type": "integer"
          },
          "offset": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "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

* [Salesforge provider guide](https://deepline.com/docs/providers/salesforge/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.