projects/parent_goal_search

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/projects/parent_goal_search
Handler	OperatelyWeb.Api.Projects.ParentGoalSearch

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
query	string	Yes	No	-
project_id	id primitive (encoded as string)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
goals	array of goal object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/projects/parent_goal_search?project_id=value&query=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "goals": [
    {
      "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"
    }
  ]
}