get_task

Endpoint#

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

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_assignees	boolean	No	No	-
include_milestone	boolean	No	No	-
include_project	boolean	No	No	-
include_creator	boolean	No	No	-
include_project_space	boolean	No	No	-
include_permissions	boolean	No	No	-
include_subscription_list	boolean	No	No	-
include_available_statuses	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
task	task object	No	Yes

cURL Example#

Copied

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

Response Example#

{
  "task": {
    "assignees": [
      "<person>"
    ],
    "available_statuses": [
      "<task_status>"
    ],
    "comments_count": 123,
    "creator": "<person>",
    "description": "value",
    "due_date": "<contextual_date>",
    "id": "value",
    "inserted_at": "2026-01-01",
    "milestone": "<milestone>",
    "name": "value",
    "permissions": "<project_permissions>",
    "priority": "value",
    "project": "<project>",
    "project_space": "<space>",
    "size": "value",
    "space": "<space>",
    "status": "<task_status>",
    "subscription_list": "<subscription_list>",
    "type": "space",
    "updated_at": "2026-01-01"
  }
}