Notes

List notes

Lists notes, newest first, a page at a time. The note body is not part of a list response.

Each note carries the records it is attached to in note_links, leaving out any record the token cannot reach — so a note can come back with an empty note_links even though somebody else can see what it is about.

Filtering

  • filter[record_type] and filter[record_id] — the record the notes are attached to. Both are required together; neither narrows anything on its own.
  • filter[created_by_member_id] — one or more team member ids, or me for whoever the token belongs to.
  • filter[date_from] and filter[date_to] — a date range over the day each note is about. Both bounds are inclusive, and either works alone.
get/public-api/v1/notes

Request

  • Base URL
    https://app.hellobonsai.com
  • URL
    https://app.hellobonsai.com/public-api/v1/notes
  • Auth
    • OAuth 2
      Authorization code: https://app.hellobonsai.com/oauth/authorize
      Token URL: https://app.hellobonsai.com/oauth/token
    • or HTTP bearer

Query parameters

page[number]integer

Page to return, starting at 1.

page[size]integer

Records per page. Defaults to 25; anything above 100 is reduced to 100.

filter[record_type]'company' | 'project' | 'contact' | 'deal'

Return notes attached to this kind of record. Requires filter[record_id].

filter[record_id]string

Return notes attached to this record, in the resource named by filter[record_type]. Requires filter[record_type].

filter[created_by_member_id]string

One or more team member ids, comma-separated or repeated. Pass me for whoever the token belongs to.

filter[date_from]string date

Return notes dated on or after this day.

filter[date_to]string date

Return notes dated on or before this day.

Response

A page of notes, newest first.

Example response

{
  "data": [
    {
      "id": "3f1c9b64-0c2d-4d19-9d4e-6c9a1f7b2f11",
      "title": "Kickoff call",
      "date": "2026-05-01",
      "visibility": "everyone",
      "created_by_member_id": 314,
      "created_at": "2026-04-14T09:12:04.000Z",
      "updated_at": "2026-04-14T09:12:04.000Z",
      "note_links": [
        {
          "id": 907,
          "record_id": 42,
          "record_type": "company"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

Changes

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