get_goal_progress_update

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/get_goal_progress_update
Handler	OperatelyWeb.Api.Queries.GetGoalProgressUpdate

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
id	string	Yes	No	-
include_author	boolean	No	Yes	-
include_acknowledged_by	boolean	No	Yes	-
include_reactions	boolean	No	Yes	-
include_goal	boolean	No	Yes	-
include_goal_targets	boolean	No	Yes	-
include_goal_checklist	boolean	No	Yes	-
include_reviewer	boolean	No	Yes	-
include_champion	boolean	No	Yes	-
include_space	boolean	No	Yes	-
include_space_members	boolean	No	Yes	-
include_subscriptions_list	boolean	No	Yes	-
include_potential_subscribers	boolean	No	Yes	-
include_unread_notifications	boolean	No	Yes	-
include_permissions	boolean	No	Yes	-

Outputs#

Field	Type	Required	Nullable
update	goal_progress_update object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_goal_progress_update?id=value&include_acknowledged_by=true&include_author=true&include_champion=true&include_goal=true&include_goal_checklist=true&include_goal_targets=true&include_permissions=true&include_potential_subscribers=true&include_reactions=true&include_reviewer=true&include_space=true&include_space_members=true&include_subscriptions_list=true&include_unread_notifications=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "update": {
    "acknowledged": true,
    "acknowledged_at": "2026-01-01T09:30:00Z",
    "acknowledging_person": "<person>",
    "author": "<person>",
    "checklist": [
      "<goal_check_update>"
    ],
    "comments_count": 123,
    "goal": "<goal>",
    "goal_target_updates": [
      "<goal_target_updates>"
    ],
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "message": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<goal_update_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "reactions": [
      "<reaction>"
    ],
    "status": "value",
    "subscription_list": "<subscription_list>",
    "timeframe": "<timeframe>"
  }
}