1. Docs
  2. API Reference
  3. List scoped operational activity within the caller's scope

List scoped operational activity within the caller's scope

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/activity

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Query Parameters

limitnumber Optional

Events per page (1-100, default 25)

range 1–100

cursorstring Optional

Opaque base64url cursor from the previous response's `pagination.next_cursor`. Omit for the first page.

qstring Optional

Free-text match against the people named on an event — who acted and who it was done to. One field rather than separate actor and subject filters: an operational administrator asks what happened with a person, not which side of the event they were on.

max length 200

actionstring Optional

Filter to a single action key. Only keys on the Workspace activity allowlist match; anything else returns nothing rather than reaching into the wider audit log.

node_idstring Optional

Filter to events recorded at one hierarchy node. Still intersected with the caller's accessible subtree, so naming a node outside their scope returns nothing.

fromstring · date-time Optional

Lower bound (inclusive).

tostring · date-time Optional

Upper bound (inclusive).

Responses

application/json

  • itemsWorkspaceActivityResponseDto[]*
  • paginationobject*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1–100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

WorkspaceActivityResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/activity?limit=0&cursor=value&q=value&action=value&node_id=value&from=value&to=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "action": "string",
      "actor_label": "string",
      "resource_type": "string",
      "resource_label": "string",
      "application_node_id": "string",
      "application_node_path": "string",
      "created_at": "2026-04-20T12:00:00.000Z",
      "subject_type": "identity",
      "subject_id": "string"
    }
  ],
  "pagination": {
    "next_cursor": "string"
  }
}
 Related endpoints
GETResolve the caller's operational authority in the Environment
GETList identities within the caller's operational scope
GETList an identity's responsibilities within the caller's scope
GETList the identity roles the caller may grant
GETList the hierarchy locations the caller may assign at
GETList the hierarchy nodes the caller can see in this Environment
GETList identity invitations within the caller's scope
POSTInvite an identity into a location with a role
GETDownload the scoped activity feed as CSV
GETHow long activity history is kept for this Account
POSTResend a scoped invitation
DELETERevoke a scoped invitation
POSTGrant an identity a role at a hierarchy node
PATCHMove or re-role an existing assignment
DELETERemove an identity's role assignment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy