> ## 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 Calls: Inputs, Cost & CLI Example
> List calls. Nooks Nooks List Calls 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_calls:{}' --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: `prospect`, `sequence`, `sequenceStep`, `callDisposition`, `owner`. Max 3. |
Show raw input schema
### Input JSON Schema
````json theme={null}
{
"type": "object",
"description": "Returns a paginated list of calls made on the Nooks SEP. Supports filtering by ID and updatedAt range. There is no fixed API-enforced historical lookback window for this endpoint. You can page through all retained Nooks SEP call records available in the workspace. Historical availability depends on when the workspace started using Nooks SEP and the workspace's retained call data. Use `filter[time]` to fetch by when the call occurred, or `filter[createdAt]` / `filter[updatedAt]` for ingestion and sync workflows. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/calls?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by updatedAt range: ```bash curl -X GET 'https://partner-api.nooks.in/v1/calls?filter[updatedAt][gte]=2025-01-01T00:00:00Z&filter[updatedAt][lt]=2026-01-01T00:00:00Z' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by IDs: ```bash curl -X GET 'https://partner-api.nooks.in/v1/calls?filter[id]=550e8400-e29b-41d4-a716-446655440000,660e8400-e29b-41d4-a716-446655440001' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by account: ```bash curl -X GET 'https://partner-api.nooks.in/v1/calls?filter[account][id]=990e8400-e29b-41d4-a716-446655440099' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by owner (user who placed the call): ```bash curl -X GET 'https://partner-api.nooks.in/v1/calls?filter[owner][id]=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 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})*)?$"
},
"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
},
"time": {
"type": "object",
"description": "Filter calls that occurred at or after this timestamp (ISO 8601). `time` is the actual call time (distinct from `createdAt`, which is the ingestion time).",
"properties": {
"gte": {
"type": "string",
"description": "Filter calls that occurred at or after this timestamp (ISO 8601). `time` is the actual call time (distinct from `createdAt`, which is the ingestion time).",
"format": "date-time"
},
"lte": {
"type": "string",
"description": "Filter calls that occurred at or before this timestamp (ISO 8601).",
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
},
"createdAt": {
"type": "object",
"description": "Filter calls ingested at or after this timestamp (ISO 8601).",
"properties": {
"gte": {
"type": "string",
"description": "Filter calls ingested at or after this timestamp (ISO 8601).",
"format": "date-time"
},
"lte": {
"type": "string",
"description": "Filter calls ingested at or before this timestamp (ISO 8601).",
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
},
"prospect": {
"type": "object",
"description": "Filter calls to a specific prospect.",
"properties": {
"id": {
"type": "string",
"description": "Filter calls to a specific prospect.",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"account": {
"type": "object",
"description": "Filter calls associated with a specific account. Matches the account snapshot stored on the call at ingestion time.",
"properties": {
"id": {
"type": "string",
"description": "Filter calls associated with a specific account. Matches the account snapshot stored on the call at ingestion time.",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"callDisposition": {
"type": "object",
"description": "Filter calls by their recorded disposition.",
"properties": {
"id": {
"type": "string",
"description": "Filter calls by their recorded disposition.",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"owner": {
"type": "object",
"description": "Filter calls placed by a specific user. Matched via the linked caller's `userId` (the User who owns the caller record).",
"properties": {
"id": {
"type": "string",
"description": "Filter calls placed by a specific user. Matched via the linked caller's `userId` (the User who owns the caller record)."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"include": {
"type": "array",
"description": "Comma-separated relations to expand inline. Valid values: `prospect`, `sequence`, `sequenceStep`, `callDisposition`, `owner`. Max 3.",
"maxItems": 3,
"items": {
"type": "string",
"enum": [
"prospect",
"sequence",
"sequenceStep",
"callDisposition",
"owner"
]
}
}
},
"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 call record",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the call",
"format": "uuid"
},
"source": {
"type": "string",
"description": "Source/type of the call (e.g., nooks, outreach, salesforce)"
},
"duration": {
"type": "number",
"description": "Duration of the call in seconds"
},
"from": {
"type": [
"string",
"null"
],
"description": "Phone number of the rep who made/received the call"
},
"to": {
"type": [
"string",
"null"
],
"description": "Phone number of the prospect"
},
"direction": {
"type": [
"string",
"null"
],
"description": "Direction of the call"
},
"recordingUrl": {
"type": [
"string",
"null"
],
"description": "URL to the call recording"
},
"time": {
"type": "string",
"description": "Wall-clock time the call actually happened. Distinct from `createdAt` (ingestion time) — `time` is what the dialer / telephony layer recorded. Use this for call-time-based queries and filtering.",
"format": "date-time"
},
"prospect": {
"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
},
"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
},
"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
},
"callDisposition": {
"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
},
"owner": {
"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 call was created",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "When the call was last updated",
"format": "date-time"
}
},
"required": [
"id",
"source",
"duration",
"from",
"to",
"direction",
"recordingUrl",
"time",
"prospect",
"sequence",
"sequenceStep",
"callDisposition",
"owner",
"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_calls --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`.