Comment

Get list of comments.

get/api/v1/comment/list

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

Requested page offset.

sizeinteger

Requested page size.

sortOrder'Descending' | 'Ascending'

Order of comments by modified date time (default is descending).

offsetDatestring date-time

Include cards from/since (as per requested sort order) its offset date type.

offsetDateEndstring date-time

Include cards to/until (as per requested sort order) its offset date type.

offsetDateType'CreatedDate' | 'ModifiedDate' | 'SystemModifiedDate'

Offset date type.

offsetModifiedstring date-time

Include comments from/since (as per requested sort order) its modified date.

offsetIdstring

Id of last recieved comment in the previous batch when using offsetModified

offsetHistoryIdstring

Next page of resources when offsetModified set

commentIdsstring[]

List of comment ids to filter comment list by.

cardIdsstring[]

List of card ids to filter comment list by.

authorizeCardIdsBeforeSearchboolean

Do authorize card ids before search.

searchQuerystring

Plaintext search query to filter comment list by. Please use prefix 'To:' or 'From:' in order to filter by recipient oy by sender.

groupCommentboolean

comment is in group

recipientIdsstring[]

List of recipient ids (either a user or a group) to filter comment list by.

senderIdsstring[]

List of user ids as senders (From) to filter comment list by.

mutedIdsstring[]

List of muted user/group ids for muted logic comment list by.

shouldIncludeMutedIdsboolean

List focused/muted comment list

contactFilterRelation'Or' | 'And' | 'OrNot' | 'AndNot'

Query relation for contact filters (userIds, groupIds and senderIds). Default is 'or'.

exactShareContactIdsstring[]

List of contact ids (user or group) to filter result list by exact matching of comments's share list.

tagFilterRelation'Or' | 'And' | 'OrNot' | 'AndNot'

Query relation for tag/sharedTag filters. Default is 'and'.

tagsstring[]

List of tags to filter card list by.

sharedTagsstring[]

List of shared tags to filter card list by.

excludeTagFilterRelation'Or' | 'And' | 'OrNot' | 'AndNot'

Query relation for excludeTag/excludeSharedTag filters. Default is 'and'.

excludeTagsstring[]

List of exclude tags to filter card list by.

excludeSharedTagsstring[]

List of exclude shared tags to filter card list by.

cardTypesCardType[]

List of card types to filter card list by.

htmlFormatstring

Html format of comment body.

returnFormatstring

Return format temporary - small is return only id

includeSignedLinksboolean

Include signed links for attachments

Headers

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Response

OK

sizeinteger required

Page size

offsetinteger required

Page offset

offsetHistoryIdstring

Offset history id

totalSizeinteger required

Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

Changes

No recorded changes to this operation across all 1 revision of this API.