Skip to content

Goals API: List discussions

Endpoint#

PropertyValue
Typequery
MethodGET
Path/api/external/v1/goals/list_discussions
HandlerOperatelyWeb.Api.Goals.ListDiscussions

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
goal_idid primitive (encoded as string)YesNo-

Outputs#

FieldTypeRequiredNullable
discussionsarray of goal_discussion objectYesNo

cURL Example#

Copied
curl --request GET \
  --url "https://app.operately.com/api/external/v1/goals/list_discussions?goal_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "discussions": [
    {
      "__typename": "value",
      "activity_id": "value",
      "author": "<person>",
      "comment_count": 123,
      "content": "value",
      "id": "value",
      "inserted_at": "2026-01-01",
      "title": "value"
    }
  ]
}