get_milestone

Endpoint#

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

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_comments	boolean	No	No	-
include_project	boolean	No	No	-
include_creator	boolean	No	No	-
include_permissions	boolean	No	No	-
include_space	boolean	No	No	-
include_subscription_list	boolean	No	No	-
include_available_statuses	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
milestone	milestone object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_milestone?id=value&include_available_statuses=true&include_comments=true&include_creator=true&include_permissions=true&include_project=true&include_space=true&include_subscription_list=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "milestone": {
    "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"
  }
}