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

> List accounts (companies) in your Nooks workspace, filtered by domain or update time. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List accounts (companies) in your Nooks workspace, filtered by domain or update time.

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

## 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_accounts',
  {
    "page": {
      "size": 50,
      "after": "cursor_123",
      "before": "cursor_123"
    },
    "filter": {
      "id": "id_123",
      "name": "Example",
      "domain": "example.com"
    }
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute nooks_list_accounts --input '{
  "page": {
    "size": 50,
    "after": "cursor_123",
    "before": "cursor_123"
  },
  "filter": {
    "id": "id_123",
    "name": "Example",
    "domain": "example.com"
  }
}' --json
```

## Example response

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

## Input reference

Returns a paginated list of accounts (companies) in the workspace. Supports filtering by indexed account columns. Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/accounts?page[size]=50' \ -H "Authorization: Bearer nooks-api-..." ` Filter by domain: `bash curl -X GET 'https://partner-api.nooks.in/v1/accounts?filter[domain]=acme.com' \ -H "Authorization: Bearer nooks-api-..." ` Note: results are restricted to accounts sourced from a customer CRM (`salesforce`, `hubspot`).

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.page` | `object` | No | — | Number of items per page (max 100) |
| `payload.filter` | `object` | No | — | Comma-separated list of account UUIDs to fetch |

<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 accounts (companies) in the workspace. Supports filtering by indexed account columns. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/accounts?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by domain: ```bash curl -X GET 'https://partner-api.nooks.in/v1/accounts?filter[domain]=acme.com' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Note: results are restricted to accounts sourced from a customer CRM (`salesforce`, `hubspot`).",
    "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": "Comma-separated list of account UUIDs to fetch",
        "properties": {
          "id": {
            "type": "string",
            "description": "Comma-separated list of account UUIDs to fetch"
          },
          "name": {
            "type": "string",
            "description": "Filter accounts by exact name match"
          },
          "domain": {
            "type": "string",
            "description": "Filter accounts by exact domain match"
          },
          "crmId": {
            "type": "string",
            "description": "Filter accounts by CRM external ID"
          },
          "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
      }
    },
    "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 account Format: `uuid`. |
| `result.data.data[].name` | `string \| null` | Yes | — | Name of the account (company) |
| `result.data.data[].domain` | `string \| null` | Yes | — | Primary domain associated with the account |
| `result.data.data[].numEmployees` | `integer \| null` | Yes | — | Number of employees at the account |
| `result.data.data[].linkedInUrl` | `string \| null` | Yes | — | LinkedIn company page URL Format: `uri`. |
| `result.data.data[].description` | `string \| null` | Yes | — | Free-form description of the account |
| `result.data.data[].createdAt` | `string` | Yes | — | When the account was created Format: `date-time`. |
| `result.data.data[].updatedAt` | `string` | Yes | — | When the account 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 account (company) record",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the account",
                  "format": "uuid"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Name of the account (company)"
                },
                "domain": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Primary domain associated with the account"
                },
                "numEmployees": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "description": "Number of employees at the account"
                },
                "linkedInUrl": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "LinkedIn company page URL",
                  "format": "uri"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Free-form description of the account"
                },
                "createdAt": {
                  "type": "string",
                  "description": "When the account was created",
                  "format": "date-time"
                },
                "updatedAt": {
                  "type": "string",
                  "description": "When the account was last updated",
                  "format": "date-time"
                }
              },
              "required": [
                "id",
                "name",
                "domain",
                "numEmployees",
                "linkedInUrl",
                "description",
                "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.