Companies API: Get activity

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/companies/get_activity
Handler	OperatelyWeb.Api.Companies.GetActivity

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
id	id primitive (encoded as string)	Yes	No	-
include_unread_goal_notifications	boolean	No	No	-
include_unread_project_notifications	boolean	No	No	-
include_permissions	boolean	No	No	-
include_subscriptions_list	boolean	No	No	-
include_potential_subscribers	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
activity	activity object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/companies/get_activity?id=value&include_permissions=true&include_potential_subscribers=true&include_subscriptions_list=true&include_unread_goal_notifications=true&include_unread_project_notifications=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "activity": {
    "__typename": "value",
    "action": "value",
    "author": "<person>",
    "comment_thread": "<comment_thread>",
    "content": "<activity_content>",
    "event_data": "<activity_data_union>",
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<activity_permissions>",
    "person": "<person>",
    "resource": "<activity_resource_union>",
    "scope_id": "value",
    "scope_type": "value",
    "updated_at": "2026-01-01T09:30:00Z"
  }
}