Show All Notes

Show All Notes

GET

Retrieve notes for a supported entity type.

Request

GET /v1/note

Query Parameters

Parameter	Type	Required	Description
entity_name	string	Yes	Entity type. Allowed values: candidate, contact, organization, job, deal.
searchText	string	No	Search text inside note content.
page	integer	No	Page number. Default: 1.
limit	integer	No	Records per page. Default: 10. Requests above 100 are capped at 100.

Request Example

GET /v1/note?entity_name=candidate&searchText=interview&page=1&limit=10

Response

200

{
  "total": 1,
  "per_page": 10,
  "current_page": 1,
  "last_page": 1,
  "next_page_url": null,
  "prev_page_url": null,
  "from": 1,
  "to": 1,
  "data": [
    {
      "id": 84,
      "note_type": {
        "id": 2,
        "label": "General"
      },
      "note": "Candidate is available for an interview next week.",
      "related_to": "candidate_0d25558c1a77fc2d7d98",
      "related_record": {
        "slug": "candidate_0d25558c1a77fc2d7d98"
      },
      "related_to_type": 1,
      "created_by": {
        "id": 1
      },
      "updated_by": {
        "id": 1
      },
      "created_at": "2026-07-24T10:15:00.000Z",
      "updated_at": "2026-07-24T10:15:00.000Z"
    }
  ]
}

400

{
  "message": "Missing required query parameter: entity_name"
}