> ## 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: Inputs, Cost & CLI Example

> Get prospect by ID. Nooks Nooks Get Prospect docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=nooks_get_prospect:{"id":"{{id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name              | Type     | Required | Default | Description                                                                                                                                                                          |
| ----------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `payload.id`      | `string` | Yes      |         | Unique identifier for the prospect                                                                                                                                                   |
| `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. |

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

  ### Input JSON Schema

  ````json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | A sales prospect                               |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute nooks_get_prospect --payload '{
  "id": "string"
}' --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`.