get_activities

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/get_activities
Handler	OperatelyWeb.Api.Queries.GetActivities

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
scope_id	string	Yes	No	-
scope_type	activity_scope_type enum (person, company, space, project, milestone, task, goal)	Yes	No	-
actions	array of string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
activities	array of activity object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_activities?actions[]=value&scope_id=value&scope_type=person" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "activities": [
    {
      "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>",
      "resource_id": "value",
      "resource_type": "value",
      "scope_id": "value",
      "scope_type": "value",
      "updated_at": "2026-01-01T09:30:00Z"
    }
  ]
}