goals/get_check_ins

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/goals/get_check_ins
Handler	OperatelyWeb.Api.Queries.GetGoalCheckIns

Authentication#

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

Inputs#

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

Outputs#

Field	Type	Required	Nullable
check_ins	array of goal_progress_update object	No	Yes

cURL Example#

Copied

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

Response Example#

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