Nooks: Get Prospect

Get prospect by ID.

Tool ID: nooks_get_prospect

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'nooks_get_prospect',
  {
    "id": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute nooks_get_prospect --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "name": "Example",
    "firstName": "Jane",
    "lastName": "Doe",
    "title": "VP of Engineering",
    "primaryEmail": "jane.doe@example.com",
    "linkedInUrl": "https://example.com",
    "crmId": "crm_123",
    "account": {
      "id": "id_123",
      "_href": "example"
    },
    "sequenceStates": [
      {
        "id": "id_123",
        "_href": "example"
      }
    ],
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-01-15T12:00:00Z"
  }
}

Use deepline tools get nooks_get_prospect --json for the latest machine-readable contract.

Input reference

Returns a single prospect by its unique identifier. Example:

bash curl -X GET 'https://partner-api.nooks.in/v1/prospects/990e8400-e29b-41d4-a716-446655440020' \ -H "Authorization: Bearer nooks-api-..."

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Unique identifier for the prospect Format: `uuid`.
`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	—	A sales prospect
`result.data.id`	`string`	Yes	—	Unique identifier for the prospect Format: `uuid`.
`result.data.name`	`string \| null`	Yes	—	Full name of the prospect
`result.data.firstName`	`string \| null`	Yes	—	First name of the prospect
`result.data.lastName`	`string \| null`	Yes	—	Last name of the prospect
`result.data.title`	`string \| null`	Yes	—	Job title of the prospect
`result.data.primaryEmail`	`string \| null`	Yes	—	Primary email address of the prospect Format: `email`.
`result.data.linkedInUrl`	`string \| null`	Yes	—	LinkedIn profile URL of the prospect Format: `uri`.
`result.data.crmId`	`string \| null`	Yes	—	External ID of the prospect in the customer’s CRM
`result.data.account`	`object \| null`	Yes	—	A reference to a related resource
`result.data.account.id`	`string`	Yes	—	Unique identifier of the referenced resource
`result.data.account._href`	`string`	Yes	—	API path to the referenced resource
`result.data.sequenceStates`	`array`	Yes	—	Sequence enrollments for this prospect
`result.data.sequenceStates[].id`	`string`	Yes	—	Unique identifier of the referenced resource
`result.data.sequenceStates[]._href`	`string`	Yes	—	API path to the referenced resource
`result.data.createdAt`	`string`	Yes	—	When the prospect was created Format: `date-time`.
`result.data.updatedAt`	`string`	Yes	—	When the prospect was last updated Format: `date-time`.
`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: Get Prospect

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation