GET/projects/api/v3/comments.json

Get a list of comments

Query Params

  • Name
    updatedAfterDate
    Type
    string
    Description

    filter by risks updated after specified date (deprecated, use updatedAfter)

  • Name
    updatedAfter
    Type
    string
    Description

    filter by risks updated after specified date

  • Name
    searchTerm
    Type
    string
    Description

    filter by comment content (like v1 filterText param)

  • Name
    publishedStartDate
    Type
    string
    Description

    filter by published after date

  • Name
    publishedEndDate
    Type
    string
    Description

    filter by published before date

  • Name
    projectType
    Type
    string
    Description

    filter by project type

  • Name
    projectStatuses
    Type
    string
    Description

    filter by project statuses

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    date
    Allowed values
    • all
    • date
    • project
    • user
    • type
  • Name
    cursor
    Type
    string
    Description

    cursor used for pagination. When using this pagination mode the page and pageSize will be ignored, using limit to control the number of items. If any other filter is modified during the cursor iteration the response will fallback to the first page.

  • Name
    commentStatus
    Type
    string
    Description

    filter by commment status

    Allowed values
    • all
    • read
    • unread
  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    limit
    Type
    integer
    Description

    number of items to show when providing the cursor.

  • Name
    strictHTML
    Type
    boolean
    Description

    use strict html filtering for content

    Default
    false
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    onlyStarredProjects
    Type
    boolean
    Description

    filter by starred projects only

  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids

    Format
    Comma separated values
  • Name
    projectTagIds
    Type
    array[integer]
    Description

    filter by project tag ids

    Format
    Comma separated values
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description

    filter by project owner ids

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    projectHealths
    Type
    array[integer]
    Description

    filter by project healths

    0: not set 1: bad 2: ok 3: good

    Format
    Comma separated values
    Allowed values
    • 0
    • 1
    • 2
    • 3
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description

    filter by company ids

    Format
    Comma separated values
  • Name
    projectCategoryIds
    Type
    array[integer]
    Description

    filter by project category ids

    Format
    Comma separated values
  • Name
    objectTypes
    Type
    array[string]
    Description

    filter by object types

    Format
    Comma separated values
    Allowed values
    • task
    • file
    • notebook
    • milestone
    • link
    • event
    • status
    • projectupdate
  • Name
    objectType
    Type
    array[string]
    Description

    object type where the comment is attached to (deprecated, use objectTypes)

    Format
    Comma separated values
    Allowed values
    • task
    • file
    • notebook
    • milestone
    • link
    • event
    • status
    • projectupdate
  • Name
    objectIds
    Type
    array[integer]
    Description

    filter by object IDs

    Format
    Comma separated values
  • Name
    notifiedUserIds
    Type
    array[integer]
    Description

    filter by users who got notified for the comments

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • reactions
    • users
    • projects
    • projects.companies
    • files
    • fileversions
    • tasks
    • notebooks
    • milestones
    • links
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[tasks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • dateUpdated
    • parentTaskId
    • isPrivate
    • status
    • tasklistId
    • startDate
    • dueDate
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[notebooks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • description
    • contents
    • type
    • isPrivate
    • locked
    • lockdownId
    • secureContent
    • projectId
    • createdByUserID
    • updatedByUserID
    • deletedByUserID
    • dateUpdated
    • dateCreated
    • dateDeleted
    • deleted
    • categoryId
    • notebookVersionID
    • notebookVersionCreatedDateTime
    • notebookVersionUpdatedDateTime
    • latestVersionNo
    • commentsCount
    • readCommentsCount
    • contentHTML
    • privacy
    • commentFollowers
    • changeFollowers
    • projectNotifyCommentIncludeCreator
    • tagIds
  • Name
    fields[milestones]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • description
    • deadline
    • completed
    • projectId
    • createdOn
    • lastChangedOn
    • creatorUserId
    • reminder
    • private
    • lockdownId
    • status
    • completedOn
    • completerId
    • percentageComplete
  • Name
    fields[links]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • title
    • description
    • code
    • width
    • height
    • isPrivate
    • provider
    • projectId
    • createdAt
    • forceNewWindow
    • deleted
    • deletedAt
    • updatedAt
    • categoryId
    • createdBy
    • deletedBy
    • updatedBy
  • Name
    fields[fileversions]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • fileVersionId
    • fileId
    • versionNo
    • name
    • originalName
    • size
    • uploadedBy
    • uploadedAt
    • description
    • status
    • projectId
    • reactions
    • commentsCount
    • commentsCountRead
    • displayName
  • Name
    fields[files]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • isPrivate
    • latestFileVersionNo
    • versionId
    • status
    • description
    • lockdownId
    • tagIds
    • changeFollowers
    • commentFollowers
    • originalName
    • displayName
    • isLocked
    • lockedByUserId
    • lockedDate
    • size
    • uploadedDate
    • uploadedByUserID
    • updatedAt
    • deletedAt
    • deletedBy
    • fileSource
    • projectId
    • numLikes
    • reactions
    • versions
    • downloadURL
    • previewURL
    • thumbURL
    • relatedItems
    • commentsCount
    • commentsCountRead
    • categoryId
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    fields[comments]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • objectType
    • objectId
    • title
  • Name
    commentIds
    Type
    array[integer]
    Description

    filter by comment ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    CommentsResponse contains information about a group of comments.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    404
    Description
    404 Not Found No Data

Examples

200 OK

CommentsResponse
{  "comments": [    {      "body": "string",      "commentLink": "string",      "contentType": "string",      "dateDeleted": "string",      "dateLastEdited": "string",      "deleted": true,      "deletedBy": 0,      "deletedByUserId": 0,      "fileCount": 0,      "fileIds": [        0      ],      "files": [        {          "id": 0,
Download Swagger