get_project

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
id	string	No	Yes	-
include_contributors	boolean	No	Yes	-
include_goal	boolean	No	Yes	-
include_key_resources	boolean	No	Yes	-
include_last_check_in	boolean	No	Yes	-
include_milestones	boolean	No	Yes	-
include_permissions	boolean	No	Yes	-
include_champion	boolean	No	Yes	-
include_reviewer	boolean	No	Yes	-
include_space	boolean	No	Yes	-
include_contributors_access_levels	boolean	No	Yes	-
include_access_levels	boolean	No	Yes	-
include_privacy	boolean	No	Yes	-
include_retrospective	boolean	No	Yes	-
include_potential_subscribers	boolean	No	Yes	-
include_unread_notifications	boolean	No	Yes	-
include_subscription_list	boolean	No	Yes	-
include_markdown	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
project	project object	Yes	No
markdown	string	No	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_project?id=value&include_access_levels=true&include_champion=true&include_contributors=true&include_contributors_access_levels=true&include_goal=true&include_key_resources=true&include_last_check_in=true&include_markdown=true&include_milestones=true&include_permissions=true&include_potential_subscribers=true&include_privacy=true&include_retrospective=true&include_reviewer=true&include_space=true&include_subscription_list=true&include_unread_notifications=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "markdown": "value",
  "project": {
    "access_levels": "<access_levels>",
    "archived_at": "2026-01-01",
    "champion": "<person>",
    "closed_at": "2026-01-01",
    "contributors": [
      "<project_contributor>"
    ],
    "description": "value",
    "goal": "<goal>",
    "goal_id": "value",
    "id": "value",
    "inserted_at": "2026-01-01",
    "is_archived": true,
    "is_outdated": true,
    "is_pinned": true,
    "key_resources": [
      "<project_key_resource>"
    ],
    "last_check_in": "<project_check_in>",
    "milestones": [
      "<milestone>"
    ],
    "milestones_ordering_state": [
      "value"
    ],
    "my_role": "value",
    "name": "value",
    "next_check_in_scheduled_at": "2026-01-01",
    "next_milestone": "<milestone>",
    "next_update_scheduled_at": "2026-01-01",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<project_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "privacy": "value",
    "retrospective": "<project_retrospective>",
    "reviewer": "<person>",
    "space": "<space>",
    "space_id": "value",
    "state": "active",
    "status": "value",
    "subscription_list": "<subscription_list>",
    "success_status": "achieved",
    "task_statuses": [
      "<task_status>"
    ],
    "tasks_kanban_state": "value",
    "timeframe": "<timeframe>",
    "updated_at": "2026-01-01"
  }
}