Notifications API: Is subscribed

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/notifications/is_subscribed
Handler	OperatelyWeb.Api.Notifications.IsSubscribed

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
resource_id	id primitive (encoded as string)	Yes	No	-
resource_type	subscription_parent_type enum (project_check_in, project_retrospective, goal_update, message, resource_hub_document, resource_hub_file, resource_hub_link, comment_thread, project, milestone, project_task, space_task, kpi)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
subscribed	boolean	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/notifications/is_subscribed?resource_id=value&resource_type=project_check_in" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "subscribed": true
}