Nooks: List Prospects

List prospects.

Tool ID: nooks_list_prospects

Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example. Inspect the live contract before executing it:

deepline tools get nooks_list_prospects --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get 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.

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

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Nooks: List Prospects

Run this action

Example response

Input reference

Output reference

Deepline cost

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation