Goals API: Count children

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/goals/count_children
Handler	OperatelyWeb.Api.Goals.CountChildren

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	-

Outputs#

Field	Type	Required	Nullable
children_count	goal_children_count object	Yes	No

cURL Example#

Copied

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

Response Example#

{
  "children_count": {
    "check_ins_count": 123,
    "discussions_count": 123,
    "docs_and_files_count": 123
  }
}