Retrieve a single activity

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

Description

Retrieves an activity given its ID.

Attention

The Workiva Platform does not guarantee that actions taken in the platform will always result in the same Activity ID. Please rely on the ActivityAction alias field to determine if an activity is relevant to your use case.

GET /admin/v1/activities/{activityId}

Required OAuth Scopes

activity:read

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
activityId	path	string	true	The unique identifier of the activity

Code Samples

curl

curl -X GET https://api.app.wdesk.com/admin/v1/activities/{activityId} \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/admin/v1/activities/{activityId} \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/admin/v1/activities/{activityId}" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  '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

400 - Bad Request

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses

200 Response

{
  "action": {
    "alias": "workspace_membership_create",
    "category": "Administration",
    "deprecated": false,
    "id": "com.workiva.administration.workspace_membership.create",
    "name": "Workspace membership created",
    "type": "com.workiva.administration.workspace_membership.create"
  },
  "activityDateTime": "2021-01-30T13:55:01Z",
  "description": "Adam Admin added the user 'John Public' to the workspace 'Organization Management'",
  "id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgwOlFYVmthWFJNYjJjZVFYVmthWFJNYjJjNk5ETXpaamN4TUdVMU5HRTBOR1V5Tm1JeU5ERmtOREJsWXpNMlpHWXhNVFE=",
  "organization": {
    "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
    "name": "Workiva Inc."
  },
  "outcome": "success",
  "performer": {
    "displayName": "Adam Admin",
    "id": "V0ZWc2VyHzE0NT8xNzAyMDA",
    "ipAddress": "192.168.1.1",
    "type": "com.workiva.iam.principal.user",
    "uniqueName": "admin_admin@example.com"
  },
  "tags": [
    "correlationId:1a2b3c4d5e6f000db88c0009f9f1",
    "eventId:LM4s-wJyTgW4NTbNZi_86v"
  ],
  "targets": [
    {
      "displayName": "John Public",
      "id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
      "type": "com.workiva.administration.user",
      "uniqueName": "john_public"
    }
  ],
  "workspace": {
    "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
    "name": "Organization Management"
  }
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}