SAsaleshandy
prospects

List notes for a prospect

Returns a paginated list of notes attached to the specified prospect, along with any draft note and pagination metadata. Use the <code>skip</code> and <code>take</code> query parameters to page through results.

get/v1/prospects/{prospectId}/notes

Request

Path parameters

prospectIdstring required

Public prospect ID returned by prospect read/list APIs.

Query parameters

skipnumber

Number of notes to skip (offset).

takenumber

Number of notes to return per page (max 100).

Response

Notes fetched successfully

unknown required

Example response

{
  "message": "Notes fetched successfully",
  "payload": {
    "notes": [
      {
        "id": "Nt7Yp4Za",
        "prospectId": "Pr9xQ2Lm",
        "visibility": "1",
        "status": "1",
        "pinnedAt": "2026-04-21T10:59:21.000Z",
        "createdAt": "2026-04-21T10:57:07.000Z",
        "updatedAt": "2026-04-21T10:59:21.000Z",
        "editedAt": "2026-04-21T10:58:29.000Z",
        "author": {
          "firstName": "Avery",
          "lastName": "Stone",
          "email": "avery.stone@example.org"
        },
        "editedBy": {
          "firstName": "Avery",
          "lastName": "Stone",
          "email": "avery.stone@example.org"
        },
        "content": "<p>Discussed annual plan and renewal timeline.</p>"
      }
    ],
    "draftNote": null,
    "pagination": {
      "skip": 0,
      "take": 20,
      "hasMore": true
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.