get_goal

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
id	id primitive (encoded as string)	Yes	No	-
include_champion	boolean	No	Yes	-
include_closed_by	boolean	No	Yes	-
include_last_check_in	boolean	No	Yes	-
include_permissions	boolean	No	Yes	-
include_projects	boolean	No	Yes	-
include_reviewer	boolean	No	Yes	-
include_space	boolean	No	Yes	-
include_space_members	boolean	No	Yes	-
include_access_levels	boolean	No	Yes	-
include_privacy	boolean	No	Yes	-
include_potential_subscribers	boolean	No	Yes	-
include_unread_notifications	boolean	No	Yes	-
include_retrospective	boolean	No	Yes	-
include_checklist	boolean	No	No	-
include_markdown	boolean	No	No	false

Outputs#

Field	Type	Required	Nullable
goal	goal object	Yes	No
markdown	string	No	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_goal?id=value&include_access_levels=true&include_champion=true&include_checklist=true&include_closed_by=true&include_last_check_in=true&include_markdown=true&include_permissions=true&include_potential_subscribers=true&include_privacy=true&include_projects=true&include_retrospective=true&include_reviewer=true&include_space=true&include_space_members=true&include_unread_notifications=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "goal": {
    "access_levels": "<access_levels>",
    "archived_at": "2026-01-01",
    "champion": "<person>",
    "checklist": [
      "<goal_check>"
    ],
    "closed_at": "2026-01-01",
    "closed_by": "<person>",
    "description": "value",
    "id": "value",
    "inserted_at": "2026-01-01",
    "is_archived": true,
    "is_closed": true,
    "is_outdated": true,
    "last_check_in": "<goal_progress_update>",
    "last_check_in_id": "value",
    "my_role": "value",
    "name": "value",
    "next_update_scheduled_at": "2026-01-01",
    "notifications": [
      "<notification>"
    ],
    "parent_goal": "<goal>",
    "parent_goal_id": "value",
    "permissions": "<goal_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "privacy": "public",
    "progress_percentage": 12.34,
    "projects": [
      "<project>"
    ],
    "retrospective": "<goal_retrospective>",
    "reviewer": "<person>",
    "space": "<space>",
    "status": "on_track",
    "success": true,
    "targets": [
      "<target>"
    ],
    "timeframe": "<timeframe>",
    "updated_at": "2026-01-01"
  },
  "markdown": "value"
}