> ## 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 Tasks: Inputs, Cost & CLI Example
> List tasks. Nooks Nooks List Tasks docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=nooks_list_tasks:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `payload.page` | `object` | No | | Number of items per page (max 100) |
| `payload.filter` | `object` | No | | Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter". |
| `payload.include` | `array` | No | | Comma-separated relations to expand inline. Valid values: `owner`, `prospect`, `sequence`, `sequenceState`, `sequenceStep`. Max 3. |
Show raw input schema
### Input JSON Schema
````json theme={null}
{
"type": "object",
"description": "Returns a paginated list of tasks. Tasks represent individual outreach activities (calls, emails, etc.) assigned to users. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/tasks?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by prospect: ```bash curl -X GET 'https://partner-api.nooks.in/v1/tasks?filter[prospect][id]=770e8400-e29b-41d4-a716-446655440003' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by action type: ```bash curl -X GET 'https://partner-api.nooks.in/v1/tasks?filter[action]=call,manual_email' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by sequence: ```bash curl -X GET 'https://partner-api.nooks.in/v1/tasks?filter[sequence][id]=550e8400-e29b-41d4-a716-446655440000' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by account (joins through the task's prospect): ```bash curl -X GET 'https://partner-api.nooks.in/v1/tasks?filter[account][id]=990e8400-e29b-41d4-a716-446655440099' \\ -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 by IDs (comma-separated UUIDs). An empty value is treated as \"no filter\".",
"properties": {
"id": {
"type": "string",
"description": "Filter by IDs (comma-separated UUIDs). An empty value is treated as \"no filter\".",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(,[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})*)?$"
},
"action": {
"type": "array",
"description": "Filter by action type (comma-separated). Valid values: call, manual_email, auto_email, manual_email_reply, auto_email_reply, basic_task, linkedin_connection_request, manual_linkedin_connection_request, manual_linkedin_message, automatic_linkedin_message, manual_sms, auto_sms",
"items": {
"type": "string",
"enum": [
"call",
"manual_email",
"auto_email",
"manual_email_reply",
"auto_email_reply",
"basic_task",
"linkedin_connection_request",
"manual_linkedin_connection_request",
"manual_linkedin_message",
"automatic_linkedin_message",
"manual_sms",
"auto_sms"
]
}
},
"status": {
"type": "array",
"description": "Filter by status (comma-separated). Valid values: pending, ready, finished, skipped, failed",
"items": {
"type": "string",
"enum": [
"pending",
"ready",
"finished",
"skipped",
"failed"
]
}
},
"priority": {
"type": "array",
"description": "Filter by priority (comma-separated). Valid values: low, normal, high, urgent",
"items": {
"type": "string",
"enum": [
"low",
"normal",
"high",
"urgent"
]
}
},
"completed": {
"type": "string",
"description": "Filter by completion state. Valid values: true, false",
"enum": [
"true",
"false"
]
},
"sequence": {
"type": "object",
"description": "Filter tasks belonging to a specific sequence",
"properties": {
"id": {
"type": "string",
"description": "Filter tasks belonging to a specific sequence",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"sequenceStep": {
"type": "object",
"description": "Filter tasks tied to a specific sequence step",
"properties": {
"id": {
"type": "string",
"description": "Filter tasks tied to a specific sequence step",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"prospect": {
"type": "object",
"description": "Filter tasks for a specific prospect",
"properties": {
"id": {
"type": "string",
"description": "Filter tasks for a specific prospect",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"account": {
"type": "object",
"description": "Filter tasks associated with a specific account. Joins through the task's prospect (`Prospect.accountId`).",
"properties": {
"id": {
"type": "string",
"description": "Filter tasks associated with a specific account. Joins through the task's prospect (`Prospect.accountId`).",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"owner": {
"type": "object",
"description": "Filter tasks assigned to a specific user",
"properties": {
"id": {
"type": "string",
"description": "Filter tasks assigned to a specific user"
}
},
"required": [],
"additionalProperties": false
},
"dueAt": {
"type": "object",
"description": "Filter tasks due at or after this timestamp (ISO 8601)",
"properties": {
"gte": {
"type": "string",
"description": "Filter tasks due at or after this timestamp (ISO 8601)",
"format": "date-time"
},
"lte": {
"type": "string",
"description": "Filter tasks due at or before this timestamp (ISO 8601)",
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
},
"sequenceState": {
"type": "object",
"description": "Filter by the state of the task's sequence state (comma-separated). Valid values: active, paused, finished, null. The sentinel `null` matches one-off tasks not associated with a sequence.",
"properties": {
"state": {
"type": "array",
"description": "Filter by the state of the task's sequence state (comma-separated). Valid values: active, paused, finished, null. The sentinel `null` matches one-off tasks not associated with a sequence.",
"items": {
"type": "string",
"enum": [
"active",
"paused",
"finished",
"null"
]
}
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"include": {
"type": "array",
"description": "Comma-separated relations to expand inline. Valid values: `owner`, `prospect`, `sequence`, `sequenceState`, `sequenceStep`. Max 3.",
"maxItems": 3,
"items": {
"type": "string",
"enum": [
"owner",
"prospect",
"sequence",
"sequenceState",
"sequenceStep"
]
}
}
},
"required": [],
"additionalProperties": false
}
````
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "A task representing an outreach activity assigned to a user",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the task",
"format": "uuid"
},
"action": {
"type": "string",
"description": "Type of action for this task: - `call`: Phone call task - `manual_email`: Manually composed email - `auto_email`: Automatically sent email - `manual_email_reply`: Manual email reply - `auto_email_reply`: Automatic email reply - `basic_task`: Generic manual task - `linkedin_connection_request`: LinkedIn connection request - `manual_linkedin_connection_request`: Manual LinkedIn connection request - `manual_linkedin_message`: Manual LinkedIn message - `automatic_linkedin_message`: Automatically sent LinkedIn message - `manual_sms`: Manual SMS message - `auto_sms`: Automatically sent SMS message",
"enum": [
"call",
"manual_email",
"auto_email",
"manual_email_reply",
"auto_email_reply",
"basic_task",
"linkedin_connection_request",
"manual_linkedin_connection_request",
"manual_linkedin_message",
"automatic_linkedin_message",
"manual_sms",
"auto_sms"
]
},
"completed": {
"type": "boolean",
"description": "Whether the task has been completed"
},
"dueAt": {
"type": "string",
"description": "When the task is due",
"format": "date-time"
},
"note": {
"type": [
"string",
"null"
],
"description": "Optional note or instructions for the task"
},
"status": {
"type": [
"string",
"null"
],
"description": "Current status of the task (pending, ready, finished, skipped, failed)"
},
"priority": {
"type": "string",
"description": "Priority level of the task",
"enum": [
"low",
"normal",
"high",
"urgent"
]
},
"owner": {
"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
},
"prospect": {
"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
},
"sequence": {
"type": [
"object",
"null"
],
"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
},
"sequenceState": {
"type": [
"object",
"null"
],
"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
},
"sequenceStep": {
"type": [
"object",
"null"
],
"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 task was created",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "When the task was last updated",
"format": "date-time"
}
},
"required": [
"id",
"action",
"completed",
"dueAt",
"note",
"status",
"priority",
"owner",
"prospect",
"sequence",
"sequenceState",
"sequenceStep",
"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
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute nooks_list_tasks --payload '{}' --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`.