Note

List Notes

Retrieves a paginated list of public notes attached to Goals, Key Results, Initiatives, or KPIs.

Only notes on resources visible to the API client are returned. Notes are ordered by created_at ascending (oldest first).

get/notes

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/notes
  • Auth: HTTP bearer

Query parameters

pageinteger
Example:1

The page you want to request. First page will be returned if omitted or invalid.

Response

OK

idinteger required

Unique identifier for the note.

kind'impediment' | 'risk' | 'learning' | 'achievement' | 'decision' | 'question' | 'comment' required

What the note records: impediment (something blocking progress), risk, learning, achievement, decision, question or a general comment.

titlestring required

Title of the note. User mentions are rendered as plain names.

descriptionstring nullable

Optional body of the note. User mentions are rendered as plain names.

resolved_atstring date-time nullable required

Timestamp when the note was resolved in ISO 8601 format, or null if unresolved.

created_atstring date-time required

Timestamp when the note was created in ISO 8601 format.

updated_atstring date-time required

Timestamp when the note was last updated in ISO 8601 format.

Example response

[
  {
    "id": 123,
    "kind": "risk",
    "title": "Supplier delivery slipping",
    "description": "We may miss the Q2 milestone.",
    "resolved_at": "2026-04-02T09:15:00Z",
    "created_at": "2026-01-20T14:45:00Z",
    "updated_at": "2026-01-21T09:10:00Z",
    "creator": {
      "id": 5,
      "name": "Thomas Weber"
    },
    "resource": {
      "type": "goal",
      "id": 42,
      "title": "Be number #1 in our market"
    },
    "comments": [
      {
        "id": 9,
        "text": "Agreed, escalating to procurement.",
        "creator": {
          "id": 5,
          "name": "Thomas Weber"
        },
        "created_at": "2026-01-20T16:00:00Z",
        "updated_at": "2026-01-20T16:00:00Z"
      }
    ]
  }
]

Changes

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