API Reference

Description

Retrieves an activity given its ID

GET /activities/{activityId}

🚧

Required OAuth Scopes:

activity:read

Parameters

ParameterInTypeRequiredDescription
activityIdpathstringtrueThe unique identifier of the activity

Code Samples

curl -X GET https://api.app.wdesk.com/admin/v1/activities/{activityId}  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://api.app.wdesk.com/admin/v1/activities/{activityId}  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/admin/v1/activities/{activityId}" \
 --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/activities/{activityId}', headers = headers)

print(r.json())

Returns

200 - OK

Details about the activity

Example Responses


{
  "id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgwOlFYVmthWFJNYjJjZVFYVmthWFJNYjJjNk5ETXpaamN4TUdVMU5HRTBOR1V5Tm1JeU5ERmtOREJsWXpNMlpHWXhNVFE=",
  "description": "Adam Admin added the user 'John Public' to the workspace 'Organization Management'",
  "action": {
    "type": "com.workiva.administration.workspace_membership.create",
    "alias": "workspace_membership_create",
    "name": "Workspace membership created",
    "category": "Administration",
    "deprecated": false
  },
  "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"
    }
  ],
  "activityDateTime": "2021-01-30T13:55:01Z",
  "workspace": {
    "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
    "name": "Organization Management"
  },
  "organization": {
    "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
    "name": "Workiva Inc."
  },
  "outcome": "success",
  "tags": [
    "correlationId:1a2b3c4d5e6f000db88c0009f9f1",
    "eventId:LM4s-wJyTgW4NTbNZi_86v"
  ]
}