Projects API: List milestones

Endpoint#

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

Authentication#

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

Inputs#

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

Outputs#

Field	Type	Required	Nullable
milestones	array of milestone object	Yes	Yes

cURL Example#

Copied

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

Response Example#

{
  "milestones": [
    {
      "__typename": "value",
      "available_statuses": [
        "<task_status>"
      ],
      "comments": [
        "<milestone_comment>"
      ],
      "comments_count": 123,
      "completed_at": "2026-01-01",
      "creator": "<person>",
      "description": "value",
      "id": "value",
      "inserted_at": "2026-01-01",
      "permissions": "<project_permissions>",
      "project": "<project>",
      "space": "<space>",
      "status": "pending",
      "subscription_list": "<subscription_list>",
      "tasks_kanban_state": "value",
      "tasks_ordering_state": [
        "value"
      ],
      "timeframe": "<timeframe>",
      "title": "value",
      "url": "value"
    }
  ]
}