Prospects

List prospects

Returns a paginated list of prospects. Supports filtering by prospect IDs, sequence enrollment, or account.

get/prospects

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/prospects
  • 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)

Query parameters

page[size]integer

Number of items per page (max 100)

page[after]string

Cursor for fetching the next page. Opaque token returned by the API in links.next; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

page[before]string

Cursor for fetching the previous page. Opaque token returned by the API in links.prev; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

filter[id]string

Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".

filter[name]string

Filter prospects by exact name match

filter[title]string

Filter prospects by exact job title match

filter[primaryEmail]string

Comma-separated list of email addresses to filter by (up to 10). Returns prospects whose primary email matches any of the provided values.

filter[crmId]string

Filter prospects by CRM external ID

filter[sequence][id]string uuid

Filter prospects enrolled in a specific sequence

filter[account][id]string uuid

Filter prospects associated with a specific account

filter[updatedAt][gte]string date-time

Filter prospects updated at or after this timestamp (ISO 8601)

filter[updatedAt][lte]string date-time

Filter prospects updated at or before this timestamp (ISO 8601)

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

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "/v1/sequences?page[size]=50",
    "next": "/v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9"
  }
}

Changes

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