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

> Get a Nooks sending mailbox by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get a Nooks sending mailbox by its ID.

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

## 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(
  'nooks_get_mailbox',
  {
    "id": "123e4567-e89b-42d3-a456-426614174000"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute nooks_get_mailbox --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --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": {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "email": "jane.doe@example.com",
    "isDefault": true,
    "user": {
      "id": "id_123",
      "_href": "example"
    },
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-01-15T12:00:00Z"
  }
}
```

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

## Input reference

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-..." `

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

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

  ### Input JSON Schema

  ````json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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 reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | An email mailbox (alias) |
| `result.data.id` | `string` | Yes | — | Unique identifier for the mailbox Format: `uuid`. |
| `result.data.email` | `string` | Yes | — | Email address of the mailbox Format: `email`. |
| `result.data.isDefault` | `boolean` | Yes | — | Whether this is the user's default mailbox |
| `result.data.user` | `object` | Yes | — | A reference to a related resource |
| `result.data.user.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.user._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.createdAt` | `string` | Yes | — | When the mailbox was created Format: `date-time`. |
| `result.data.updatedAt` | `string` | Yes | — | When the mailbox was last updated Format: `date-time`. |
| `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": "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>

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

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