Teamwork

Links

    Teamwork API

    Getting access, Developing, Testing

    Back to Teamwork

    Get a list of comments for a task

    Input

    type: object properties: parameters: type: object properties: updatedAfterDate: type: string format: date-time description: filter by updated after date (deprecated, use updatedAfter) updatedAfter: type: string format: date-time description: filter by updated after date searchTerm: type: string description: filter by comment content (like v1 filterText param) publishedStartDate: type: string format: date description: filter by published after date publishedEndDate: type: string format: date description: filter by published before date orderMode: type: string enum: - asc - desc default: asc description: order mode orderBy: type: string enum: - all - date - project - user - type default: data description: order by commentStatus: type: string enum: - all - read - unread description: filter by commment status taskId: type: integer pageSize: type: integer default: '50' description: number of items in a page page: type: integer default: '1' description: page number strictHTML: type: boolean default: 'false' description: use strict html filtering fto content getReactionsCount: type: boolean description: get reactions count userIds: type: array items: type: integer description: filter by user ids notifiedUserIds: type: array items: type: integer description: filter by users who got notified for the comments include: type: array items: enum: - reactions - users type: string description: include fields[users]: type: array items: enum: - id - firstName - lastName - title - email - companyId - company - isAdmin - isClientUser - isServiceAccount - type - deleted - avatarUrl - lengthOfDay - workingHoursId - workingHour - userRate - userCost - canAddProjects type: string required: - taskId title: Parameters

    Output

    type: object title: CommentsResponse properties: comments: type: array items: type: object title: FullComment properties: body: type: string commentLink: type: string contentType: type: string dateDeleted: type: string dateLastEdited: type: string deleted: type: boolean deletedBy: type: integer deletedByUserId: type: integer fileCount: type: integer fileIds: type: array items: type: integer files: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string htmlBody: type: string id: type: integer installation: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string installationId: type: integer isPrivate: type: integer lastEditedBy: type: integer lastEditedByUserId: type: integer lockdownID: type: integer meta: type: object title: Meta properties: isRead: type: boolean permissions: type: object title: Permissions properties: canDelete: type: boolean canEdit: type: boolean object: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string objectId: type: integer objectType: type: string peopleNotifiedCount: type: integer postedBy: type: integer postedByUserId: type: integer postedDateTime: type: string project: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string projectId: type: integer reactions: type: array items: type: object title: Reaction properties: installation: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string installationId: type: integer object: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string objectId: type: integer objectType: type: string postedDateTime: type: string type: type: string user: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string userId: type: integer reactionsCount: type: integer included: type: object properties: companies: type: object files: type: object fileversions: type: object links: type: object milestones: type: object notebooks: type: object projects: type: object tasks: type: object users: type: object meta: type: object title: Meta properties: averageSpend: type: integer limit: type: integer nextCursor: type: string page: type: object title: MetaPage properties: count: type: integer hasMore: type: boolean pageOffset: type: integer pageSize: type: integer prevCursor: type: string totalCapacity: type: integer