Companies API: Get flat work map

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/companies/get_flat_work_map
Handler	OperatelyWeb.Api.Companies.GetFlatWorkMap

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
space_id	id primitive (encoded as string)	No	Yes	-
parent_goal_id	id primitive (encoded as string)	No	Yes	-
champion_id	id primitive (encoded as string)	No	Yes	-
reviewer_id	id primitive (encoded as string)	No	Yes	-
contributor_id	id primitive (encoded as string)	No	Yes	-
only_completed	boolean	No	Yes	-
include_assignees	boolean	No	Yes	-
include_reviewer	boolean	No	Yes	-
include_tasks	boolean	No	Yes	-

Outputs#

Field	Type	Required	Nullable
work_map	array of work_map_item object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/companies/get_flat_work_map?champion_id=value&contributor_id=value&include_assignees=true&include_reviewer=true&include_tasks=true&only_completed=true&parent_goal_id=value&reviewer_id=value&space_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "work_map": [
    {
      "__typename": "value",
      "assigned_at": "2026-01-01T09:30:00Z",
      "assignees": [
        "<person>"
      ],
      "checklist": [
        "<goal_check>"
      ],
      "children": [
        "<work_map_item>"
      ],
      "completed_on": "2026-01-01",
      "id": "value",
      "is_new": true,
      "item_path": "value",
      "milestones": [
        "<work_map_milestone>"
      ],
      "name": "value",
      "next_step": "value",
      "owner": "<person>",
      "owner_path": "value",
      "parent_id": "value",
      "privacy": "public",
      "progress": 12.34,
      "project": "<project>",
      "project_path": "value",
      "reviewer": "<person>",
      "reviewer_path": "value",
      "space": "<space>",
      "space_path": "value",
      "state": "active",
      "status": "on_track",
      "targets": [
        "<target>"
      ],
      "task_status": "<task_status>",
      "timeframe": "<timeframe>",
      "type": "project"
    }
  ]
}