Comments API: List

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/comments/list
Handler	OperatelyWeb.Api.Comments.List

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
entity_id	id primitive (encoded as string)	Yes	No	-
entity_type	comment_list_entity_type enum (project_check_in, project_retrospective, project_discussion, goal_update, goal_discussion, message, resource_hub_document, resource_hub_file, resource_hub_link, space_task, project_task, kpi_entry)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
comments	array of comment object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/comments/list?entity_id=value&entity_type=project_check_in" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "comments": [
    {
      "__typename": "value",
      "author": "<person>",
      "content": "value",
      "id": "value",
      "inserted_at": "2026-01-01T09:30:00Z",
      "notification": "<notification>",
      "reactions": [
        "<reaction>"
      ]
    }
  ]
}