GET /api/v1/groups/{group_identifier}/notes
Bearer auth

Path parameters

  • group_identifier string Required

    The id or code for a group

Query parameters

  • date string

    Flow date in YYYY-MM-DD format. Defaults to latest flow date.

Responses

  • 200 application/json

    List of notes for the group

    Hide response attributes Show response attributes object
    • id integer

      The note ID

    • action string

      The type of note

      Values are celebrate_success, thank_colleague, share_frustration, or suggest_idea.

    • text string

      The note text content

    • flow_date string(date)

      The flow date when the note was created

    • created_at string(date-time)

      Timestamp when the note was created

    • author object
      Hide author attributes Show author attributes object
      • name string

        The full name of the author

      • email string

        The email of the author

    • recipients array[object]

      Recipients of thank you notes (only present for thank_colleague action)

      Hide recipients attributes Show recipients attributes object
      • name string

        The full name of the recipient

      • email string

        The email of the recipient

    • external_recipients array[string]

      External email addresses for thank you notes (only present if external recipients exist)
GET /api/v1/groups/{group_identifier}/notes 
curl \
 --request GET 'https://app.fridaypulse.com/api/v1/groups/{group_identifier}/notes' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 1,
    "text": "Great team work today!",
    "action": "celebrate_success",
    "author": {
      "name": "John Doe",
      "email": "john@example.com"
    },
    "flow_date": "2024-10-14",
    "created_at": "2024-10-14T10:30:00Z"
  }
]