Skip to content

get_project_check_ins

Endpoint#

PropertyValue
Typequery
MethodGET
Path/api/external/v1/get_project_check_ins
HandlerOperatelyWeb.Api.Queries.GetProjectCheckIns

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
project_idstringYesNo-
include_authorbooleanNoNo-
include_projectbooleanNoNo-
include_reactionsbooleanNoNo-

Outputs#

FieldTypeRequiredNullable
project_check_insarray of project_check_in objectNoYes

cURL Example#

Copied
curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_project_check_ins?include_author=true&include_project=true&include_reactions=true&project_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "project_check_ins": [
    {
      "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>"
    }
  ]
}