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

# Nooks Get Mailbox: Inputs, Cost & CLI Example

> Get mailbox by ID. Nooks Nooks Get Mailbox 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=nooks_get_mailbox:{"id":"{{id}}"}' --json
```

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

## Input Schema

| Name              | Type     | Required | Default | Description                                                              |
| ----------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ |
| `payload.id`      | `string` | Yes      |         | Unique identifier for the mailbox                                        |
| `payload.include` | `array`  | No       |         | Comma-separated relations to expand inline. Valid values: `user`. Max 3. |

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

  ### Input JSON Schema

  ````json theme={null}
  {
    "type": "object",
    "description": "Returns a single mailbox by its unique identifier. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/mailboxes/bb0e8400-e29b-41d4-a716-446655440040' \\ -H \"Authorization: Bearer nooks-api-...\" ```",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the mailbox",
        "format": "uuid"
      },
      "include": {
        "type": "array",
        "description": "Comma-separated relations to expand inline. Valid values: `user`. Max 3.",
        "maxItems": 3,
        "items": {
          "type": "string",
          "enum": [
            "user"
          ]
        }
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ````
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | An email mailbox (alias)                       |
| `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": "An email mailbox (alias)",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the mailbox",
            "format": "uuid"
          },
          "email": {
            "type": "string",
            "description": "Email address of the mailbox",
            "format": "email"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Whether this is the user's default mailbox"
          },
          "user": {
            "type": "object",
            "description": "A reference to a related resource",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier of the referenced resource"
              },
              "_href": {
                "type": "string",
                "description": "API path to the referenced resource"
              }
            },
            "required": [
              "id",
              "_href"
            ],
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "description": "When the mailbox was created",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "description": "When the mailbox was last updated",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "email",
          "isDefault",
          "user",
          "createdAt",
          "updatedAt"
        ],
        "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 nooks_get_mailbox --payload '{
  "id": "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`.