Nooks: List Mailboxes

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

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.

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

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.

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

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation