GET/projects/api/v3/fileversions/{id}/comments.json

Get a list of comments for a file version

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Query Params

  • Name
    updatedAfterDate
    Type
    string
    Description

    filter by updated after date (deprecated, use updatedAfter)

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after 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
    orderMode
    Type
    string
    Description

    order mode

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

    order by

    Default
    data
    Allowed values
    • all
    • date
    • project
    • user
    • type
  • 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
    strictHTML
    Type
    boolean
    Description

    use strict html filtering fto content

    Default
    false
  • Name
    getReactionsCount
    Type
    boolean
    Description

    get reactions count

  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user 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
  • 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

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