Endpoint#
| Property | Value |
|---|
| Type | query |
| Method | GET |
| Path | /api/external/v1/get_project_check_in |
| Handler | OperatelyWeb.Api.Queries.GetProjectCheckIn |
Authentication#
- Requires a valid API token.
- Read-only and full-access tokens can execute this query.
| Field | Type | Required | Nullable | Default |
|---|
id | string | Yes | No | - |
include_author | boolean | No | No | - |
include_acknowledged_by | boolean | No | No | - |
include_project | boolean | No | No | - |
include_space | boolean | No | No | - |
include_reactions | boolean | No | No | - |
include_subscriptions_list | boolean | No | No | - |
include_potential_subscribers | boolean | No | No | - |
include_unread_notifications | boolean | No | Yes | - |
Outputs#
| Field | Type | Required | Nullable |
|---|
project_check_in | project_check_in object | Yes | No |
cURL Example#
Copiedcurl --request GET \
--url "https://app.operately.com/api/external/v1/get_project_check_in?id=value&include_acknowledged_by=true&include_author=true&include_potential_subscribers=true&include_project=true&include_reactions=true&include_space=true&include_subscriptions_list=true&include_unread_notifications=true" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}"
Response Example#
{
"project_check_in": {
"acknowledged_at": "2026-01-01T09:30:00Z",
"acknowledged_by": "<person>",
"author": "<person>",
"comments_count": 123,
"description": "value",
"id": "value",
"inserted_at": "2026-01-01",
"notifications": [
"<notification>"
],
"potential_subscribers": [
"<subscriber>"
],
"project": "<project>",
"reactions": [
"<reaction>"
],
"space": "<space>",
"status": "on_track",
"subscription_list": "<subscription_list>"
}
}