API Reference

Retrieve a list of activities for a workspace

Description

Returns a paginated list of activities for a given organization and workspace

GET /organizations/{organizationId}/workspaces/{workspaceId}/activities

🚧

Required OAuth Scopes:

activity:read

Parameters

ParameterInTypeRequiredDescription
$filterquerystringfalseThe properties to filter the results by.
$maxpagesizequeryintegerfalseThe maximum number of results to retrieve
$nextquerystringfalsePagination cursor for next set of results.
$orderByquerystringfalseOne or more comma-separated expressions to indicate the order in which to sort the results.
organizationIdpathstringtrueOrganization Id
workspaceIdpathstringtrueThe unique identifier of the workspace

Filter Options

Available logical operators: and, or

NamePredicates Supported
action.aliaseq, in
action.ideq, in
activityDateTimeeq, lt, gt, le, ge
performer.ideq, in
target.ideq, in

Sorting Options

NameOrders Supported
activityDateTimeasc, desc

Code Samples

curl -X GET https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/workspaces/{workspaceId}/activities  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'

http GET https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/workspaces/{workspaceId}/activities  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"

wget --method=GET "https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/workspaces/{workspaceId}/activities" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/workspaces/{workspaceId}/activities', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Activity objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn't appear. If the request returns no results at all, data contains an empty array.

Example Responses


{
  "data": [
    {
      "action": {
        "id": "com.workiva.administration.workspace_membership.create",
        "alias": "workspace_membership_create",
        "category": "Administration",
        "name": "Workspace membership created",
        "deprecated": false
      },
      "id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgwOlFYVmthWFIzYjJjZVFYVmtiWFJNYjJlNk5ETXpiamN4TUdVMU5HRTlOR1V5Tm1JeU5ENGtOREJsWXpuNFpHWXhNVFE=",
      "summary": "Adam Admin added the user 'John Public' to the workspace 'Organization Management'",
      "performer": {
        "id": "V0ZWc2VyHzE0NT8xNzAyMDA",
        "type": "com.workiva.iam.principal.user",
        "displayName": "Adam Admin",
        "uniqueName": "[email protected]",
        "ipAddress": "192.168.1.1"
      },
      "targets": [
        {
          "id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
          "uniqueName": "john_public",
          "displayName": "John Public",
          "type": "com.workiva.administration.user"
        },
        {
          "id": "QWNjb3VudB81MzIzMjkwOTM4NzAzODcy",
          "displayName": "Organization Management",
          "type": "com.workiva.administration.workspace"
        }
      ],
      "activityDateTime": "2021-01-30T14:11:02Z",
      "workspace": {
        "id": "QWNjb3VudB81MzIzMjkwOTM4NzAzODcy",
        "name": "Organization Management"
      },
      "organization": {
        "id": "a25bc16f-fb62-4aff-a87e-1cca4b2113c0",
        "name": "Workiva"
      },
      "outcome": "success",
      "tags": [
        "correlationId:1a2b3c4d5e6f000db88c0009f9f1",
        "eventId:LM4s-wJyTgW4NTbNZi_86v"
      ]
    },
    {
      "action": {
        "id": "com.workiva.administration.workspace.update",
        "alias": "workspace_update",
        "category": "Administration",
        "name": "Workspace updated",
        "deprecated": false
      },
      "id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgwOlFYVmthWFJNYjJjZVFYVmthWFJNYjJjNk5ETXpaamN4TUdVMU5HRTBOR1V5Tm1JeU5ERmtOREJsWXpNMlpHWXhNVFE=",
      "summary": "Adam Admin updated the workspace 'Organization Management'",
      "performer": {
        "id": "V0ZWc2VyHzE0NT8xNzAyMDA",
        "type": "com.workiva.iam.principal.user",
        "displayName": "Adam Admin",
        "uniqueName": "[email protected]",
        "ipAddress": "192.168.1.1"
      },
      "targets": [
        {
          "id": "QWNjb3VudB81MzIzMjkwOTM4NzAzODcy",
          "uniqueName": "string",
          "displayName": "Organization Management",
          "type": "com.workiva.administration.workspace"
        }
      ],
      "activityDateTime": "2021-01-30T13:55:01Z",
      "workspace": {
        "id": "QWNjb3VudB81MzIzMjkwOTM4NzAzODcy",
        "name": "Organization Management"
      },
      "organization": {
        "id": "a25bc16f-fb62-4aff-a87e-1cca4b2113c0",
        "name": "Workiva"
      },
      "outcome": "success",
      "tags": [
        "correlationId:2a1b4dee6e9f001dbbbc0007f7f3",
        "eventId:k94s-vJyTaca5HERbNZi_21v"
      ],
      "attachments": [
        {
          "entityChanges": {
            "propertyName": "displayName",
            "new": "Organization Management",
            "old": "New Workspace"
          }
        }
      ]
    }
  ],
  "@nextLink": "{opaqueUrl}"
}