> ## 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: Get Prospect

> Get a prospect from Nooks by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get a prospect from Nooks by its ID.

> [!NOTE]
>
> Tool ID: `nooks_get_prospect`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute nooks_get_prospect --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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 describe 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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ````json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "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-...\" ```",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the prospect",
        "format": "uuid"
      },
      "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": [
      "id"
    ],
    "additionalProperties": false
  }
  ````
</details>

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

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "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
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

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