> ## 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 Prospects
> List prospects in Nooks, filtered by sequence, account or ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
List prospects in Nooks, filtered by sequence, account or ID.
> [!NOTE]
>
> Tool ID: `nooks_list_prospects`
## Run this action
This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably.
Read the live contract before you execute this action:
```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe nooks_list_prospects --json
```
## Example response
The static output schema lacks the details for a reliable example. Use `deepline describe nooks_list_prospects --json` for the complete live contract.
## Input reference
Returns a paginated list of prospects. Supports filtering by prospect IDs, sequence enrollment, or account. Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?page[size]=50' \ -H "Authorization: Bearer nooks-api-..." ` Filter by specific IDs: `bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?filter[id]=UUID1,UUID2' \ -H "Authorization: Bearer nooks-api-..." ` Filter by sequence enrollment: `bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?filter[sequence][id]=550e8400-e29b-41d4-a716-446655440000' \ -H "Authorization: Bearer nooks-api-..." ` Filter by account: `bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?filter[account][id]=990e8400-e29b-41d4-a716-446655440099' \ -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 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: `sequenceStates`. Max 3. Note: `account` is not yet includable — fetch via the `_href` on the `account` reference instead. Maximum items: 3. |
Show raw input schema
### Input JSON Schema
````json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Returns a paginated list of prospects. Supports filtering by prospect IDs, sequence enrollment, or account. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by specific IDs: ```bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?filter[id]=UUID1,UUID2' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by sequence enrollment: ```bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?filter[sequence][id]=550e8400-e29b-41d4-a716-446655440000' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by account: ```bash curl -X GET 'https://partner-api.nooks.in/v1/prospects?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})*)?$"
},
"name": {
"type": "string",
"description": "Filter prospects by exact name match"
},
"title": {
"type": "string",
"description": "Filter prospects by exact job title match"
},
"primaryEmail": {
"type": "string",
"description": "Comma-separated list of email addresses to filter by (up to 10). Returns prospects whose primary email matches any of the provided values."
},
"crmId": {
"type": "string",
"description": "Filter prospects by CRM external ID"
},
"sequence": {
"type": "object",
"description": "Filter prospects enrolled in a specific sequence",
"properties": {
"id": {
"type": "string",
"description": "Filter prospects enrolled in a specific sequence",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"account": {
"type": "object",
"description": "Filter prospects associated with a specific account",
"properties": {
"id": {
"type": "string",
"description": "Filter prospects associated with a specific account",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
},
"updatedAt": {
"type": "object",
"description": "Filter prospects updated at or after this timestamp (ISO 8601)",
"properties": {
"gte": {
"type": "string",
"description": "Filter prospects updated at or after this timestamp (ISO 8601)",
"format": "date-time"
},
"lte": {
"type": "string",
"description": "Filter prospects updated at or before this timestamp (ISO 8601)",
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"include": {
"type": "array",
"description": "Comma-separated relations to expand inline. Valid values: `sequenceStates`. Max 3. Note: `account` is not yet includable — fetch via the `_href` on the `account` reference instead.",
"maxItems": 3,
"items": {
"type": "string",
"enum": [
"sequenceStates"
]
}
}
},
"required": [],
"additionalProperties": false
}
````
## 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 prospect Format: `uuid`. |
| `result.data.data[].name` | `string \| null` | Yes | — | Full name of the prospect |
| `result.data.data[].firstName` | `string \| null` | Yes | — | First name of the prospect |
| `result.data.data[].lastName` | `string \| null` | Yes | — | Last name of the prospect |
| `result.data.data[].title` | `string \| null` | Yes | — | Job title of the prospect |
| `result.data.data[].primaryEmail` | `string \| null` | Yes | — | Primary email address of the prospect Format: `email`. |
| `result.data.data[].linkedInUrl` | `string \| null` | Yes | — | LinkedIn profile URL of the prospect Format: `uri`. |
| `result.data.data[].crmId` | `string \| null` | Yes | — | External ID of the prospect in the customer's CRM |
| `result.data.data[].account` | `object \| null` | Yes | — | A reference to a related resource |
| `result.data.data[].account.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.data[].account._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.data[].sequenceStates` | `array` | Yes | — | Sequence enrollments for this prospect |
| `result.data.data[].sequenceStates[].id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.data[].sequenceStates[]._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.data[].createdAt` | `string` | Yes | — | When the prospect was created Format: `date-time`. |
| `result.data.data[].updatedAt` | `string` | Yes | — | When the prospect 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). |
Show raw output schema
### 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": "A sales prospect",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the prospect",
"format": "uuid"
},
"name": {
"type": [
"string",
"null"
],
"description": "Full name of the prospect"
},
"firstName": {
"type": [
"string",
"null"
],
"description": "First name of the prospect"
},
"lastName": {
"type": [
"string",
"null"
],
"description": "Last name of the prospect"
},
"title": {
"type": [
"string",
"null"
],
"description": "Job title of the prospect"
},
"primaryEmail": {
"type": [
"string",
"null"
],
"description": "Primary email address of the prospect",
"format": "email"
},
"linkedInUrl": {
"type": [
"string",
"null"
],
"description": "LinkedIn profile URL of the prospect",
"format": "uri"
},
"crmId": {
"type": [
"string",
"null"
],
"description": "External ID of the prospect in the customer's CRM"
},
"account": {
"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
},
"sequenceStates": {
"type": "array",
"description": "Sequence enrollments for this prospect",
"items": {
"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 prospect was created",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "When the prospect was last updated",
"format": "date-time"
}
},
"required": [
"id",
"name",
"firstName",
"lastName",
"title",
"primaryEmail",
"linkedInUrl",
"crmId",
"account",
"sequenceStates",
"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
}
```
## 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.