SaaSFlow
DevelopersAPIReferencecomments

Retrieve comment

Retrieve a single comment by id, including who is tagged in it and who liked it. Returns 404 if the comment does not exist or belongs to another company.

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/comments/{commentId}

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length
commentId*string
Length1 <= length

Response Body

Comment details

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
transactionId*string
Formatuuid
text*string

The content of the comment.

taggedUserIds*array<string>

User IDs mentioned in the comment.

likedUserIds*array<string>

User IDs that liked the comment.

createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
curl -X GET "https://example.com/companies/string/comments/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",  "text": "string",  "taggedUserIds": [    "string"  ],  "likedUserIds": [    "string"  ],  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Create comment

Post a comment on a transaction. transactionId is required and cannot be changed later. taggedUserIds records which teammates are mentioned, which is how…

Delete comment

Delete a comment. The transaction it was attached to is untouched. Returns success even when there was nothing to delete.