V1Comments
Comment List
List all comments based on a comment type(Sequence, Execution, Execution Task Or Outcome) and ID
List all comments based on a comment type(Sequence, Execution, Execution Task Or Outcome) and ID
Authorization
access_token Authorization<token>
In: header
Query Parameters
page?integer
actual page of comments
per_page?integer
number of comments per page
order?string
order by 'field,order'
filter[commentable_type]*string
select commentable type(required)
Value in
- "sequence"
- "execution"
- "execution_task"
- "outcome"
filter[commentable_id]*string
commentable id
filter[daterange_from_to]?string
filter by creation date range
Value in
- "today"
- "yesterday"
- "last_7_days"
- "last_30_days"
- "current_month"
- "last_month"
- "02/21/2024 19:56 - 02/28/2024 19:56"
Response Body
application/json
curl -X GET "https://example.com/api/v1/comments?page=1&per_page=20&order=id%2Cdesc&filter%5Bcommentable_type%5D=sequence&filter%5Bcommentable_id%5D=udvrp0zdjd"{ "status": "ok", "data": { "pagination": { "total_pages": 0, "current_page": 0 }, "list": [ { "id": "string", "content": null, "owner": { "id": "abc123xyz", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "avatar": "https://lh3.googleusercontent.com/a/AAcHTtcLT_gPCblFHL0QKonMt4822u5qrtlsvvrm0aAC1LszcPg=s288-c-no", "created_at": "06/29/2023 21:14:57", "updated_at": "06/29/2023 21:14:57" }, "created_at": "string", "updated_at": "string" } ] }}