Skip to content

get_project_check_in

Endpoint#

PropertyValue
Typequery
MethodGET
Path/api/external/v1/get_project_check_in
HandlerOperatelyWeb.Api.Queries.GetProjectCheckIn

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
idstringYesNo-
include_authorbooleanNoNo-
include_acknowledged_bybooleanNoNo-
include_projectbooleanNoNo-
include_spacebooleanNoNo-
include_reactionsbooleanNoNo-
include_subscriptions_listbooleanNoNo-
include_potential_subscribersbooleanNoNo-
include_unread_notificationsbooleanNoYes-

Outputs#

FieldTypeRequiredNullable
project_check_inproject_check_in objectYesNo

cURL Example#

Copied
curl --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>"
  }
}