Prospects

Get prospect by ID

Returns a single prospect by its unique identifier.

get/prospects/{id}

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/prospects/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: prospects:read)

Path parameters

idstring uuid required

Unique identifier for the prospect

Query parameters

includestring[]

Comma-separated relations to expand inline. Valid values: sequenceStates. Max 3. account is not yet includable. Fetch it via the _href on the account reference instead.

includeCRMCustomFields'true' | 'false'

When true, each returned record's crmCustomFields carries the record's CRM custom fields as a single JSON object keyed by the CRM field id/key (e.g. {"hs_lead_status": "OPEN"}). Values are typed per the CRM field's data type (string, number, boolean, string array, or ISO-8601 date string, so a date field's value is not distinguishable from a string field's on the wire). A registered field with no stored value is null. Only fields with a currently-registered CRM attribute definition in the workspace are returned. The field itself is always present in responses; without this opt-in (the default) it is an empty object {} and no custom-field data is fetched.

Response

Successful response

idstring uuid required

Unique identifier for the prospect

namestring nullable required

Full name of the prospect

firstNamestring nullable required

First name of the prospect

lastNamestring nullable required

Last name of the prospect

titlestring nullable required

Job title of the prospect

primaryEmailstring email nullable required

Primary email address of the prospect

linkedInUrlstring uri nullable required

LinkedIn profile URL of the prospect

crmIdstring nullable required

External ID of the prospect in the customer's CRM

crmCustomFieldsobject required

CRM custom fields as a JSON object keyed by the CRM field id/key. Always present; populated only when the request passed includeCRMCustomFields=true, otherwise an empty object {}.

createdAtstring date-time required

When the prospect was created

updatedAtstring date-time required

When the prospect was last updated

Example response

{
  "id": "990e8400-e29b-41d4-a716-446655440020",
  "name": "Jane Doe",
  "firstName": "Jane",
  "lastName": "Doe",
  "title": "VP of Engineering",
  "primaryEmail": "jane@acme.com",
  "linkedInUrl": "https://linkedin.com/in/janedoe",
  "crmId": "003ABC123DEF456",
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceStates": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "crmCustomFields": {
    "hs_lead_status": "OPEN",
    "lifecycle_stage": "mql",
    "deal_size": 42.5,
    "is_customer": true,
    "segments": [
      "smb",
      "mid-market"
    ],
    "renewal_date": "2026-01-15T00:00:00.000Z"
  },
  "createdAt": "2025-10-01T10:00:00.000Z",
  "updatedAt": "2025-11-15T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.