Get Project Comments

GET /public/v1/projects/{projectId}/notes
Api key

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required

Query parameters

  • keepUnread boolean

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id integer(int64) Required

      The ID of the project note

    • note string Required

      The content of the project note

    • user string Required

      The name of the user who created the note

    • userId string(uuid) Required

      The ID of the user who created the note

    • createdAt string(date-time) Required

      The creation timestamp of the note

    • updatedAt string(date-time) Required

      The last updated timestamp of the note

    • viewedByUser boolean Required

      Indicates if the note has been viewed by the user

    • canEdit boolean Required

      Indicates if the user can edit the note
GET /public/v1/projects/{projectId}/notes 
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/notes' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500) 
{}
Response examples (200) 
[
  {
    "id": 1,
    "note": "This is a project note.",
    "user": "John Doe",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2024-01-01T12:00:00+00:00",
    "updatedAt": "2024-01-02T12:00:00+00:00",
    "viewedByUser": true,
    "canEdit": false
  }
]