Projects API: Get retrospective

Endpoint#

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

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	-
include_author	boolean	No	Yes	-
include_project	boolean	No	Yes	-
include_closed_at	boolean	No	Yes	-
include_permissions	boolean	No	Yes	-
include_reactions	boolean	No	Yes	-
include_subscriptions_list	boolean	No	Yes	-
include_potential_subscribers	boolean	No	Yes	-
include_unread_notifications	boolean	No	Yes	-

Outputs#

Field	Type	Required	Nullable
retrospective	project_retrospective object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/projects/get_retrospective?include_author=true&include_closed_at=true&include_permissions=true&include_potential_subscribers=true&include_project=true&include_reactions=true&include_subscriptions_list=true&include_unread_notifications=true&project_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "retrospective": {
    "__typename": "value",
    "acknowledged_at": "2026-01-01T09:30:00Z",
    "acknowledged_by": "<person>",
    "author": "<person>",
    "champion": "<person>",
    "closed_at": "2026-01-01",
    "content": "value",
    "id": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<project_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "project": "<project>",
    "reactions": [
      "<reaction>"
    ],
    "reviewer": "<person>",
    "subscription_list": "<subscription_list>"
  }
}