> ## 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: List Mailboxes

> List the sending mailboxes in your Nooks workspace, filtered by user. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the sending mailboxes in your Nooks workspace, filtered by user.

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

## 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_list_mailboxes',
  {
    "page": {
      "size": 50,
      "after": "cursor_123",
      "before": "cursor_123"
    },
    "filter": {
      "userId": "user_123",
      "updatedAt": {
        "gte": "2026-01-15T12:00:00Z",
        "lt": "2026-01-15T12:00:00Z"
      }
    },
    "include": [
      "user"
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute nooks_list_mailboxes --input '{
  "page": {
    "size": 50,
    "after": "cursor_123",
    "before": "cursor_123"
  },
  "filter": {
    "userId": "user_123",
    "updatedAt": {
      "gte": "2026-01-15T12:00:00Z",
      "lt": "2026-01-15T12:00:00Z"
    }
  },
  "include": [
    "user"
  ]
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe nooks_list_mailboxes --json` for the complete live contract.

## Input reference

Returns a paginated list of mailboxes (email aliases). Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/mailboxes?page[size]=50' \ -H "Authorization: Bearer nooks-api-..." ` Filter by user: `bash curl -X GET 'https://partner-api.nooks.in/v1/mailboxes?filter[userId]=KKLvN5wQoghWFwUvC75CZ12QM7I3' \ -H "Authorization: Bearer nooks-api-..." `

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.page` | `object` | No | — | Number of items per page (max 100) |
| `payload.filter` | `object` | No | — | Filter mailboxes belonging to a specific user (Firebase UID) |
| `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 paginated list of mailboxes (email aliases). Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/mailboxes?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by user: ```bash curl -X GET 'https://partner-api.nooks.in/v1/mailboxes?filter[userId]=KKLvN5wQoghWFwUvC75CZ12QM7I3' \\ -H \"Authorization: Bearer nooks-api-...\" ```",
    "properties": {
      "page": {
        "type": "object",
        "description": "Number of items per page (max 100)",
        "properties": {
          "size": {
            "type": "integer",
            "description": "Number of items per page (max 100)",
            "default": 50,
            "minimum": 1,
            "maximum": 100
          },
          "after": {
            "type": "string",
            "description": "Cursor for fetching the next page. Opaque token returned by the API in `links.next`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
          },
          "before": {
            "type": "string",
            "description": "Cursor for fetching the previous page. Opaque token returned by the API in `links.prev`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "filter": {
        "type": "object",
        "description": "Filter mailboxes belonging to a specific user (Firebase UID)",
        "properties": {
          "userId": {
            "type": "string",
            "description": "Filter mailboxes belonging to a specific user (Firebase UID)",
            "minLength": 1
          },
          "updatedAt": {
            "type": "object",
            "description": "Filter by minimum updatedAt (ISO 8601 datetime)",
            "properties": {
              "gte": {
                "type": "string",
                "description": "Filter by minimum updatedAt (ISO 8601 datetime)",
                "format": "date-time"
              },
              "lt": {
                "type": "string",
                "description": "Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)",
                "format": "date-time"
              }
            },
            "required": [],
            "additionalProperties": false
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "include": {
        "type": "array",
        "description": "Comma-separated relations to expand inline. Valid values: `user`. Max 3.",
        "maxItems": 3,
        "items": {
          "type": "string",
          "enum": [
            "user"
          ]
        }
      }
    },
    "required": [],
    "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` | Yes | — | Unique identifier for the mailbox Format: `uuid`. |
| `result.data.data[].email` | `string` | Yes | — | Email address of the mailbox Format: `email`. |
| `result.data.data[].isDefault` | `boolean` | Yes | — | Whether this is the user's default mailbox |
| `result.data.data[].user` | `object` | Yes | — | A reference to a related resource |
| `result.data.data[].user.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.data[].user._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.data[].createdAt` | `string` | Yes | — | When the mailbox was created Format: `date-time`. |
| `result.data.data[].updatedAt` | `string` | Yes | — | When the mailbox was last updated Format: `date-time`. |
| `result.data.links` | `object` | No | — | Pagination links for navigating through results. Links are returned as relative references (path + query) that should be resolved against the base URL of the request. |
| `result.data.links.first` | `string` | No | — | URL for the first page Format: `uri-reference`. |
| `result.data.links.prev` | `string \| null` | No | — | URL for the previous page (null if on first page) Format: `uri-reference`. |
| `result.data.links.next` | `string \| null` | No | — | URL for the next page (null if on last page) Format: `uri-reference`. |
| `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",
            "items": {
              "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
            }
          },
          "links": {
            "type": "object",
            "description": "Pagination links for navigating through results. Links are returned as relative references (path + query) that should be resolved against the base URL of the request.",
            "properties": {
              "first": {
                "type": "string",
                "description": "URL for the first page",
                "format": "uri-reference"
              },
              "prev": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL for the previous page (null if on first page)",
                "format": "uri-reference"
              },
              "next": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL for the next page (null if on last page)",
                "format": "uri-reference"
              }
            },
            "additionalProperties": false
          }
        },
        "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.